openapi.yaml

openapi: 3.0.1
info:
  title: Proovid Electronic Verification
  description: >-
    Proovid API is a RESTful application that specializes in electronic
    verification (Proof of address and Proof of Identity) by employing an
    advanced risk-tiered approacch in combination with a smart Risk assessment
    system. <a href='docs/PROOVid_ELV.pdf' target='_blank'>More information</a> 
  version: v1
  contact:
    name: General information
    url: http://www.proovid.com
    email: info@proovid.com
servers:
  - url: https://proovidapi.azurewebsites.net
tags:
  - name: NaturalPerson
  - name: Address
  - name: Document
  - name: Screening
  - name: Health
paths:
  /api/Address/AddressVerification/{id}:
    get:
      tags:
        - Address
      operationId: Address_verifyById
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressVerificationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/AddressVerificationResult'
            text/plain:
              schema:
                $ref: '#/components/schemas/AddressVerificationResult'
    delete:
      tags:
        - Address
      operationId: Address_verifyById
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressVerificationDeleteResult'
            text/json:
              schema:
                $ref: '#/components/schemas/AddressVerificationDeleteResult'
            text/plain:
              schema:
                $ref: '#/components/schemas/AddressVerificationDeleteResult'
  /api/Address/AddressVerification/{id}/certificate.pdf:
    get:
      tags:
        - Address
      operationId: Address_verifyCertificatePdf
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: Success
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/AddressVerifyCertificatePdfResponse'
        '401':
          description: Unauthorized
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/AddressVerifyCertificatePdf401Response'
        '404':
          description: Not Found
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/AddressVerifyCertificatePdf404Response'
  /api/Address/VerificationByLevel:
    post:
      tags:
        - Address
      operationId: Address_verifyByLevel
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddressRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/AddressRequest'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/AddressRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AddressRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressVerificationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/AddressVerificationResult'
            text/plain:
              schema:
                $ref: '#/components/schemas/AddressVerificationResult'
  /api/Address/NaturalPersonELV:
    post:
      tags:
        - Address
      operationId: Address_createNaturalPersonElv
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NaturalPersonELVRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/NaturalPersonELVRequest'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/NaturalPersonELVRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/NaturalPersonELVRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressVerificationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/AddressVerificationResult'
            text/plain:
              schema:
                $ref: '#/components/schemas/AddressVerificationResult'
  /api/Address/LinkResponse:
    post:
      tags:
        - Address
      operationId: Address_linkResponse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InfoGps'
          text/json:
            schema:
              $ref: '#/components/schemas/InfoGps'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/InfoGps'
          application/*+json:
            schema:
              $ref: '#/components/schemas/InfoGps'
      responses:
        '200':
          description: Success
  /api/Document/DocumentVerification/{id}:
    get:
      tags:
        - Document
      operationId: Document_verifyStatus
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentVerificationResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/DocumentVerificationResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/DocumentVerificationResponse'
    delete:
      tags:
        - Document
      operationId: Document_verifyDeletion
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDocumentVerificationResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/DeleteDocumentVerificationResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/DeleteDocumentVerificationResponse'
  /api/Document/DocumentVerification/{id}/certificate.pdf:
    get:
      tags:
        - Document
      operationId: Document_getCertificate
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: Success
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/DocumentGetCertificateResponse'
        '401':
          description: Unauthorized
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/DocumentGetCertificate401Response'
        '404':
          description: Not Found
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/DocumentGetCertificate404Response'
  /api/Document/VerifyDocument:
    post:
      tags:
        - Document
      operationId: Document_verifyStatus
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentVerificationRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/DocumentVerificationRequest'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/DocumentVerificationRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/DocumentVerificationRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentVerificationResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/DocumentVerificationResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/DocumentVerificationResponse'
  /api/Health/Status:
    get:
      tags:
        - Health
      operationId: Health_statusCheck
      responses:
        '200':
          description: Success
  /api/Health/Version:
    get:
      tags:
        - Health
      operationId: Health_getVersion
      responses:
        '200':
          description: Success
  /api/NaturalPerson:
    post:
      tags:
        - NaturalPerson
      operationId: NaturalPerson_createOrUpdate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddNaturalPersonRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/AddNaturalPersonRequest'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/AddNaturalPersonRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AddNaturalPersonRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddNaturalPersonResponseBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/AddNaturalPersonResponseBaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/AddNaturalPersonResponseBaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
  /api/NaturalPerson/verify:
    post:
      tags:
        - NaturalPerson
      operationId: NaturalPerson_verifyDetails
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddNaturalPersonRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/AddNaturalPersonRequest'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/AddNaturalPersonRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AddNaturalPersonRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddNaturalPersonResponseBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/AddNaturalPersonResponseBaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/AddNaturalPersonResponseBaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
  /api/NaturalPerson/addLive:
    post:
      tags:
        - NaturalPerson
      operationId: NaturalPerson_addLiveDetails
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddNaturalPersonLiveRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/AddNaturalPersonLiveRequest'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/AddNaturalPersonLiveRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AddNaturalPersonLiveRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddNaturalPersonLiveResponseBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/AddNaturalPersonLiveResponseBaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/AddNaturalPersonLiveResponseBaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
  /api/NaturalPerson/verifyentity:
    post:
      tags:
        - NaturalPerson
      operationId: NaturalPerson_verifyEntity
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddNaturalPersonRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/AddNaturalPersonRequest'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/AddNaturalPersonRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AddNaturalPersonRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddNaturalPersonResponseBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/AddNaturalPersonResponseBaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/AddNaturalPersonResponseBaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
  /api/NaturalPerson/{naturalPersonId}/updateDocuments:
    post:
      tags:
        - NaturalPerson
      operationId: NaturalPerson_updateDocuments
      parameters:
        - name: naturalPersonId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NaturalPersonDocumentsRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/NaturalPersonDocumentsRequest'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/NaturalPersonDocumentsRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/NaturalPersonDocumentsRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/UpdateNaturalPersonDocumentsResponseBaseResponse
            text/json:
              schema:
                $ref: >-
                  #/components/schemas/UpdateNaturalPersonDocumentsResponseBaseResponse
            text/plain:
              schema:
                $ref: >-
                  #/components/schemas/UpdateNaturalPersonDocumentsResponseBaseResponse
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
  /api/NaturalPerson/{naturalPersonId}/updateDocuments/verify:
    post:
      tags:
        - NaturalPerson
      operationId: NaturalPerson_verifyDocuments
      parameters:
        - name: naturalPersonId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NaturalPersonDocumentsRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/NaturalPersonDocumentsRequest'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/NaturalPersonDocumentsRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/NaturalPersonDocumentsRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/UpdateNaturalPersonDocumentsResponseBaseResponse
            text/json:
              schema:
                $ref: >-
                  #/components/schemas/UpdateNaturalPersonDocumentsResponseBaseResponse
            text/plain:
              schema:
                $ref: >-
                  #/components/schemas/UpdateNaturalPersonDocumentsResponseBaseResponse
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
  /api/NaturalPerson/{naturalPersonId}/verify:
    post:
      tags:
        - NaturalPerson
      operationId: NaturalPerson_verifyDetails
      parameters:
        - name: naturalPersonId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SumSubVerificationResponseBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/SumSubVerificationResponseBaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/SumSubVerificationResponseBaseResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
  /api/NaturalPerson/{naturalPersonId}/status:
    get:
      tags:
        - NaturalPerson
      operationId: NaturalPerson_getStatus
      parameters:
        - name: naturalPersonId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NaturalPersonResponseBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/NaturalPersonResponseBaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/NaturalPersonResponseBaseResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
  /api/NaturalPerson/{naturalPersonId}/get:
    get:
      tags:
        - NaturalPerson
      operationId: NaturalPerson_getDetails
      parameters:
        - name: naturalPersonId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NaturalPersonResponseBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/NaturalPersonResponseBaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/NaturalPersonResponseBaseResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
  /api/NaturalPerson/{naturalPersonId}/updateInfo:
    post:
      tags:
        - NaturalPerson
      operationId: NaturalPerson_updateInformation
      parameters:
        - name: naturalPersonId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateNaturalPersonInfoRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/UpdateNaturalPersonInfoRequest'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/UpdateNaturalPersonInfoRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UpdateNaturalPersonInfoRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NaturalPersonInfoResponseBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/NaturalPersonInfoResponseBaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/NaturalPersonInfoResponseBaseResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
  /api/NaturalPerson/verificationRecord/{verificationId}:
    get:
      tags:
        - NaturalPerson
      operationId: NaturalPerson_getVerificationRecord
      parameters:
        - name: verificationId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NaturalPersonInfoResponseBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/NaturalPersonInfoResponseBaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/NaturalPersonInfoResponseBaseResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
  /api/NaturalPerson/{naturalPersonId}/certificate:
    get:
      tags:
        - NaturalPerson
      operationId: NaturalPerson_getCertificate
      parameters:
        - name: naturalPersonId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NaturalPersonGetCertificate200Response'
            text/json:
              schema:
                $ref: '#/components/schemas/NaturalPersonGetCertificate200Response'
            text/plain:
              schema:
                $ref: '#/components/schemas/NaturalPersonGetCertificateResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NaturalPersonGetCertificate401Response'
            text/json:
              schema:
                $ref: '#/components/schemas/NaturalPersonGetCertificate401Response'
            text/plain:
              schema:
                $ref: '#/components/schemas/NaturalPersonGetCertificate401Response'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NaturalPersonGetCertificate404Response'
            text/json:
              schema:
                $ref: '#/components/schemas/NaturalPersonGetCertificate404Response'
            text/plain:
              schema:
                $ref: '#/components/schemas/NaturalPersonGetCertificate404Response'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NaturalPersonGetCertificate500Response'
            text/json:
              schema:
                $ref: '#/components/schemas/NaturalPersonGetCertificate500Response'
            text/plain:
              schema:
                $ref: '#/components/schemas/NaturalPersonGetCertificate500Response'
  /api/NaturalPerson/{naturalPersonId}/delete:
    delete:
      tags:
        - NaturalPerson
      operationId: NaturalPerson_removeById
      parameters:
        - name: naturalPersonId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
  /api/NaturalPerson/{naturalPersonId}/verifications:
    get:
      tags:
        - NaturalPerson
      operationId: NaturalPerson_getVerifications
      parameters:
        - name: naturalPersonId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SumSubVerificationResponseListBaseResponse
            text/json:
              schema:
                $ref: >-
                  #/components/schemas/SumSubVerificationResponseListBaseResponse
            text/plain:
              schema:
                $ref: >-
                  #/components/schemas/SumSubVerificationResponseListBaseResponse
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
  /api/NaturalPerson/{id}:
    get:
      tags:
        - NaturalPerson
      operationId: NaturalPerson_getById
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AmlReport'
            text/json:
              schema:
                $ref: '#/components/schemas/AmlReport'
            text/plain:
              schema:
                $ref: '#/components/schemas/AmlReport'
    delete:
      tags:
        - NaturalPerson
      operationId: NaturalPerson_deleteById
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAmlReport'
            text/json:
              schema:
                $ref: '#/components/schemas/DeleteAmlReport'
            text/plain:
              schema:
                $ref: '#/components/schemas/DeleteAmlReport'
  /api/NaturalPerson/{reference}:
    get:
      tags:
        - NaturalPerson
      operationId: NaturalPerson_getById
      parameters:
        - name: reference
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AmlReport'
            text/json:
              schema:
                $ref: '#/components/schemas/AmlReport'
            text/plain:
              schema:
                $ref: '#/components/schemas/AmlReport'
  /api/Screening/NaturalPerson:
    post:
      tags:
        - Screening
      operationId: Screening_submitNaturalPersonScreening
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NaturalPersonRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/NaturalPersonRequest'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/NaturalPersonRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/NaturalPersonRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AmlReport'
            text/json:
              schema:
                $ref: '#/components/schemas/AmlReport'
            text/plain:
              schema:
                $ref: '#/components/schemas/AmlReport'
  /api/Screening/NaturalPerson/{id}:
    get:
      tags:
        - Screening
      operationId: Screening_getNaturalPersonById
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AmlReport'
            text/json:
              schema:
                $ref: '#/components/schemas/AmlReport'
            text/plain:
              schema:
                $ref: '#/components/schemas/AmlReport'
    delete:
      tags:
        - Screening
      operationId: Screening_removeNaturalPerson
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAmlReport'
            text/json:
              schema:
                $ref: '#/components/schemas/DeleteAmlReport'
            text/plain:
              schema:
                $ref: '#/components/schemas/DeleteAmlReport'
  /api/Screening/AmlReport/{reference}:
    get:
      tags:
        - Screening
      operationId: Screening_getAmlReport
      parameters:
        - name: reference
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AmlReport'
            text/json:
              schema:
                $ref: '#/components/schemas/AmlReport'
            text/plain:
              schema:
                $ref: '#/components/schemas/AmlReport'
components:
  schemas:
    AddNaturalPersonDataSaveResult:
      type: object
      properties:
        naturalPersonAdded:
          $ref: '#/components/schemas/BaseResponse'
        idDocumentSaved:
          $ref: '#/components/schemas/BaseResponse'
        livenessCheckURL:
          $ref: '#/components/schemas/StringBaseResponse'
        faceSaved:
          $ref: '#/components/schemas/BaseResponse'
        addressDocumentSaved:
          $ref: '#/components/schemas/BaseResponse'
        verificationStarted:
          $ref: '#/components/schemas/BaseResponse'
        allSucceeded:
          type: boolean
          readOnly: true
    AddNaturalPersonInfoRequest:
      type: object
      properties:
        firstName:
          type: string
          nullable: true
        lastName:
          type: string
          nullable: true
        legalName:
          type: string
          nullable: true
        dob:
          type: string
          format: date-time
          nullable: true
    AddNaturalPersonLiveRequest:
      type: object
      properties:
        clientReferenceId:
          type: string
          nullable: true
        verificationType:
          $ref: '#/components/schemas/eVerificationType'
    AddNaturalPersonLiveResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
        clientReferenceId:
          type: string
          nullable: true
        token:
          type: string
          nullable: true
    AddNaturalPersonLiveResponseBaseResponse:
      type: object
      properties:
        errorCode:
          type: integer
          format: int32
        errorMessage:
          type: string
          nullable: true
        data:
          $ref: '#/components/schemas/AddNaturalPersonLiveResponse'
        succeeded:
          type: boolean
          readOnly: true
    AddNaturalPersonRequest:
      type: object
      properties:
        info:
          $ref: '#/components/schemas/AddNaturalPersonInfoRequest'
        clientReferenceId:
          type: string
          nullable: true
        documents:
          $ref: '#/components/schemas/NaturalPersonDocumentsRequest'
    AddNaturalPersonResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
        clientReferenceId:
          type: string
          nullable: true
        documentImages:
          $ref: '#/components/schemas/DocumentImages'
        dataSaveResponses:
          $ref: '#/components/schemas/AddNaturalPersonDataSaveResult'
        verifications:
          $ref: '#/components/schemas/SumSubVerificationResponse'
    AddNaturalPersonResponseBaseResponse:
      type: object
      properties:
        errorCode:
          type: integer
          format: int32
        errorMessage:
          type: string
          nullable: true
        data:
          $ref: '#/components/schemas/AddNaturalPersonResponse'
        succeeded:
          type: boolean
          readOnly: true
    AddressDocumentVerificationResult:
      type: object
      properties:
        reference:
          type: string
          nullable: true
        documentDate:
          type: string
          format: date-time
          nullable: true
        documentStatus:
          type: integer
          format: int32
        documentResult:
          type: string
          nullable: true
        validityPeriod:
          type: integer
          format: int32
        error:
          type: string
          nullable: true
        additionalInfo:
          $ref: '#/components/schemas/ShuftiAddressDataResponse'
    AddressRequest:
      type: object
      properties:
        referenceId:
          type: string
          nullable: true
        email:
          type: string
          nullable: true
        naturalPersonId:
          type: integer
          format: int64
          nullable: true
        naturalPersonIndexId:
          type: integer
          format: int64
          nullable: true
        name:
          type: string
          nullable: true
        surname:
          type: string
          nullable: true
        mobilePhone:
          type: string
          nullable: true
        language:
          type: string
          nullable: true
        verificationLevel:
          type: integer
          format: int32
        document:
          type: string
          nullable: true
        street:
          type: string
          nullable: true
        streetNumber:
          type: string
          nullable: true
        unit:
          type: string
          nullable: true
        district:
          type: string
          nullable: true
        city:
          type: string
          nullable: true
        region:
          type: string
          nullable: true
        zipCode:
          type: string
          nullable: true
        country:
          type: string
          nullable: true
        fullAddress:
          type: string
          nullable: true
        skipDocumentComparison:
          type: boolean
        validityPeriod:
          type: integer
          format: int32
    AddressVerificationDeleteResult:
      type: object
      properties:
        id:
          type: integer
          format: int64
        systemId:
          type: integer
          format: int32
        success:
          type: integer
          format: int32
        message:
          type: string
          nullable: true
    AddressVerificationResult:
      type: object
      properties:
        id:
          type: integer
          format: int64
        reference:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
        verificationLevel:
          type: integer
          format: int32
        levels:
          $ref: '#/components/schemas/DescriptionLevels'
        documentVerification:
          $ref: '#/components/schemas/AddressDocumentVerificationResult'
        userVerificationUrl:
          type: string
          nullable: true
        qrCode:
          type: string
          nullable: true
        creationTime:
          type: string
          format: date-time
        error:
          type: string
          nullable: true
    Agent:
      type: object
      properties:
        isDesktop:
          type: boolean
        isPhone:
          type: boolean
        useragent:
          type: string
          nullable: true
        deviceName:
          type: string
          nullable: true
        browserName:
          type: string
          nullable: true
        platformName:
          type: string
          nullable: true
    AmlRecord:
      type: object
      properties:
        id:
          type: integer
          format: int64
        source:
          type: string
          nullable: true
        firstName:
          type: string
          nullable: true
        middleName:
          type: string
          nullable: true
        lastName:
          type: string
          nullable: true
        gender:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
        isDeath:
          type: boolean
          nullable: true
        dateOfBirth:
          type: string
          format: date-time
          nullable: true
        placeOfBirth:
          type: string
          nullable: true
        urlReport:
          type: string
          nullable: true
        categories:
          type: array
          items:
            type: string
          nullable: true
        notes:
          type: string
          nullable: true
        sanctionsReferences:
          type: array
          items:
            type: string
          nullable: true
        officialLists:
          type: array
          items:
            type: string
          nullable: true
        importanDates:
          type: array
          items:
            type: string
          nullable: true
        otherNames:
          type: array
          items:
            type: string
          nullable: true
        idNumbers:
          type: array
          items:
            type: string
          nullable: true
        associates:
          type: array
          items:
            type: string
          nullable: true
        images:
          type: array
          items:
            type: string
          nullable: true
        relatedPersons:
          type: array
          items:
            $ref: '#/components/schemas/Associate'
          nullable: true
        name:
          type: string
          nullable: true
        score:
          type: number
          format: double
        entityType:
          type: string
          nullable: true
        filters:
          type: array
          items:
            type: string
          nullable: true
        matchTypes:
          type: array
          items:
            type: string
          nullable: true
        alternativeNames:
          type: array
          items:
            type: string
          nullable: true
        sources:
          type: array
          items:
            type: string
          nullable: true
        types:
          type: array
          items:
            type: string
          nullable: true
        assets:
          type: array
          items:
            $ref: '#/components/schemas/Asset'
          nullable: true
        media:
          type: array
          items:
            $ref: '#/components/schemas/Media'
          nullable: true
        fields:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/Field'
            nullable: true
          nullable: true
        sourceNotes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SourceNote'
          nullable: true
    AmlReport:
      type: object
      properties:
        creationTime:
          type: string
          format: date-time
          nullable: true
        reviewedVerificationStatus:
          type: string
          nullable: true
        numberOfRecords:
          type: integer
          format: int32
        naturalPerson:
          $ref: '#/components/schemas/NaturalPerson'
        amlRecords:
          type: array
          items:
            $ref: '#/components/schemas/AmlRecord'
          nullable: true
    Asset:
      type: object
      properties:
        publicUrl:
          type: string
          nullable: true
        source:
          type: string
          nullable: true
        type:
          type: string
          nullable: true
    Associate:
      type: object
      properties:
        association:
          type: string
          nullable: true
        name:
          type: string
          nullable: true
    BaseResponse:
      type: object
      properties:
        errorCode:
          type: integer
          format: int32
        errorMessage:
          type: string
          nullable: true
        succeeded:
          type: boolean
          readOnly: true
    DeleteAmlReport:
      type: object
      properties:
        id:
          type: integer
          format: int64
        systemId:
          type: integer
          format: int32
        success:
          type: integer
          format: int32
        message:
          type: string
          nullable: true
    DeleteDocumentVerificationResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
        systemId:
          type: integer
          format: int32
        success:
          type: integer
          format: int32
        message:
          type: string
          nullable: true
    DescriptionLevels:
      type: object
      properties:
        level1:
          $ref: '#/components/schemas/Level'
        level2:
          $ref: '#/components/schemas/Level'
        level3:
          $ref: '#/components/schemas/Level'
        level4:
          $ref: '#/components/schemas/Level'
    DocumentAddressResponse:
      type: object
      properties:
        street:
          type: string
          nullable: true
        streetNumber:
          type: string
          nullable: true
        buildingName:
          type: string
          nullable: true
        buildingNumber:
          type: string
          nullable: true
        flatNumber:
          type: string
          nullable: true
        city:
          type: string
          nullable: true
        state:
          type: string
          nullable: true
        zipCode:
          type: string
          nullable: true
        country:
          type: string
          nullable: true
    DocumentImages:
      type: object
      properties:
        idDocumentId:
          type: string
          nullable: true
        additionalIdDocumentId:
          type: string
          nullable: true
        faceId:
          type: string
          nullable: true
        addressId:
          type: string
          nullable: true
    DocumentVerificationData:
      type: object
      properties:
        firstName:
          type: string
          nullable: true
        lastName:
          type: string
          nullable: true
        middleName:
          type: string
          nullable: true
        fullName:
          type: string
          nullable: true
        documentNumber:
          type: string
          nullable: true
        issueDate:
          type: string
          format: date-time
          nullable: true
        expiredDate:
          type: string
          format: date-time
          nullable: true
        dob:
          type: string
          format: date-time
          nullable: true
        documentType:
          type: string
          nullable: true
        countryBirth:
          type: string
          nullable: true
        countryDocument:
          type: string
          nullable: true
        faceMatchConfidence:
          type: integer
          format: int32
          nullable: true
    DocumentVerificationRequest:
      type: object
      properties:
        email:
          type: string
          nullable: true
        country:
          type: string
          nullable: true
        document:
          type: string
          nullable: true
        additionalDocument:
          type: string
          nullable: true
        face:
          type: string
          nullable: true
        documentType:
          type: string
          nullable: true
        naturalPersonId:
          type: integer
          format: int64
          nullable: true
    DocumentVerificationResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
        systemId:
          type: integer
          format: int32
        status:
          type: integer
          format: int32
        documentData:
          $ref: '#/components/schemas/DocumentVerificationData'
        documentResult:
          $ref: '#/components/schemas/DocumentVerificationResult'
        declinedReason:
          type: string
          nullable: true
        declinedCodeProovid:
          type: string
          nullable: true
    DocumentVerificationResult:
      type: object
      properties:
        documentValidity:
          type: boolean
          nullable: true
        documentVisibility:
          type: boolean
          nullable: true
        mustNotBeExpired:
          type: boolean
          nullable: true
        documentNumber:
          type: boolean
          nullable: true
        issueDate:
          type: boolean
          nullable: true
        expiredDate:
          type: boolean
          nullable: true
        dob:
          type: boolean
          nullable: true
        name:
          type: boolean
          nullable: true
        documentCountry:
          type: boolean
          nullable: true
        selectedType:
          type: boolean
          nullable: true
        faceOnDocumentMatched:
          type: boolean
          nullable: true
    Error:
      type: object
      properties:
        service:
          type: string
          nullable: true
        key:
          type: string
          nullable: true
        message:
          type: string
          nullable: true
    Field:
      type: object
      properties:
        value:
          type: string
          nullable: true
        source:
          type: string
          nullable: true
        tag:
          type: string
          nullable: true
    Geolocation:
      type: object
      properties:
        host:
          type: string
          nullable: true
        ip:
          type: string
          nullable: true
        rdns:
          type: string
          nullable: true
        asn:
          type: string
          nullable: true
        isp:
          type: string
          nullable: true
        countryName:
          type: string
          nullable: true
        countryCode:
          type: string
          nullable: true
        regionName:
          type: string
          nullable: true
        regionCode:
          type: string
          nullable: true
        city:
          type: string
          nullable: true
        postalCode:
          type: string
          nullable: true
        continentName:
          type: string
          nullable: true
        continentCode:
          type: string
          nullable: true
        latitude:
          type: string
          nullable: true
        longitude:
          type: string
          nullable: true
        metroCode:
          type: string
          nullable: true
        timezone:
          type: string
          nullable: true
    GpsLocation:
      type: object
      properties:
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
        accuracy:
          type: number
          format: double
          nullable: true
        altitude:
          type: number
          format: double
          nullable: true
        altitudeAccuracy:
          type: number
          format: double
          nullable: true
        heading:
          type: string
          nullable: true
        speed:
          type: string
          nullable: true
    IDDocType:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
        - 8
        - 9
        - 10
        - 11
        - 12
        - 13
        - 14
        - 15
        - 16
        - 17
        - 18
        - 19
        - 20
        - 21
      type: integer
      format: int32
    Info:
      type: object
      properties:
        agent:
          $ref: '#/components/schemas/Agent'
        geolocation:
          $ref: '#/components/schemas/Geolocation'
    InfoGps:
      type: object
      properties:
        link:
          type: string
          nullable: true
        coords:
          type: array
          items:
            $ref: '#/components/schemas/GpsLocation'
          nullable: true
    Level:
      type: object
      properties:
        id:
          type: integer
          format: int64
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        statusDescription:
          type: string
          nullable: true
        steps:
          type: array
          items:
            type: string
          nullable: true
        errors:
          type: array
          items:
            type: string
          nullable: true
        declinedCodes:
          type: array
          items:
            type: string
          nullable: true
    Media:
      type: object
      properties:
        title:
          type: string
          nullable: true
        date:
          type: string
          nullable: true
        snippet:
          type: string
          nullable: true
        url:
          type: string
          nullable: true
    Name:
      type: object
      properties:
        firstName:
          type: string
          nullable: true
        middleName:
          nullable: true
        lastName:
          type: string
          nullable: true
        fullName:
          type: string
          nullable: true
    NaturalPerson:
      type: object
      properties:
        id:
          type: integer
          format: int64
          nullable: true
        systemId:
          type: integer
          format: int32
        firstName:
          type: string
          nullable: true
        lastName:
          type: string
          nullable: true
        middleName:
          type: string
          nullable: true
        dateOfBirth:
          type: string
          format: date-time
        countryOrigin:
          type: string
          nullable: true
        countryResidence:
          type: string
          nullable: true
        countryMainFunds:
          type: string
          nullable: true
    NaturalPersonAddressVerificationResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/eStatus'
        comment:
          type: string
          nullable: true
        rejectLabels:
          type: array
          items:
            $ref: '#/components/schemas/RejectLabelType'
          nullable: true
        firstName:
          type: string
          nullable: true
        lastName:
          type: string
          nullable: true
        issuedDate:
          type: string
          format: date-time
          nullable: true
        imageId:
          type: string
          nullable: true
        creationDate:
          type: string
          format: date-time
        lastUpdatedDate:
          type: string
          format: date-time
        address:
          $ref: '#/components/schemas/DocumentAddressResponse'
    NaturalPersonAmlVerificationHitResponse:
      type: object
      properties:
        dataSourceName:
          type: string
          nullable: true
        categories:
          type: array
          items:
            type: string
          nullable: true
        name:
          type: string
          nullable: true
        country:
          type: string
          nullable: true
        politicalPositions:
          type: array
          items:
            type: string
          nullable: true
        relatedUrls:
          type: array
          items:
            type: string
          nullable: true
        birthDates:
          type: array
          items:
            type: string
          nullable: true
        matchTypes:
          type: array
          items:
            type: string
          nullable: true
        matchStatus:
          type: string
          nullable: true
    NaturalPersonAmlVerificationResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/eStatus'
        comment:
          type: string
          nullable: true
        categories:
          type: array
          items:
            type: string
          nullable: true
        hasSanctions:
          $ref: '#/components/schemas/eSanctionAnswers'
        isPep:
          $ref: '#/components/schemas/ePepAnswers'
        hasNegativeReputation:
          $ref: '#/components/schemas/eNegativeReputationAnswers'
        creationDate:
          type: string
          format: date-time
        lastUpdatedDate:
          type: string
          format: date-time
        hits:
          type: array
          items:
            $ref: '#/components/schemas/NaturalPersonAmlVerificationHitResponse'
          nullable: true
    NaturalPersonDocumentRequest:
      type: object
      properties:
        country:
          type: string
          nullable: true
        document:
          type: string
          nullable: true
    NaturalPersonDocumentVerificationResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/eStatus'
        comment:
          type: string
          nullable: true
        rejectLabels:
          type: array
          items:
            $ref: '#/components/schemas/RejectLabelType'
          nullable: true
        firstName:
          type: string
          nullable: true
        lastName:
          type: string
          nullable: true
        dateOfBirth:
          type: string
          format: date-time
          nullable: true
        gender:
          $ref: '#/components/schemas/eGender'
        country:
          type: string
          nullable: true
        issuedDate:
          type: string
          format: date-time
          nullable: true
        issueAuthority:
          type: string
          nullable: true
        firstIssuedDate:
          type: string
          format: date-time
          nullable: true
        validUntil:
          type: string
          format: date-time
          nullable: true
        number:
          type: string
          nullable: true
        additionalNumber:
          type: string
          nullable: true
        mrzLine1:
          type: string
          nullable: true
        mrzLine2:
          type: string
          nullable: true
        mrzLine3:
          type: string
          nullable: true
        imageId:
          type: string
          nullable: true
        additionalImageId:
          type: string
          nullable: true
        creationDate:
          type: string
          format: date-time
        lastUpdatedDate:
          type: string
          format: date-time
    NaturalPersonDocumentsRequest:
      type: object
      properties:
        idDocument:
          $ref: '#/components/schemas/NaturalPersonIdDocumentRequest'
        addressDocument:
          $ref: '#/components/schemas/NaturalPersonDocumentRequest'
    NaturalPersonELVRequest:
      type: object
      properties:
        naturalPersonIndexId:
          type: integer
          format: int64
        street:
          type: string
          nullable: true
        streetNumber:
          type: string
          nullable: true
        unit:
          type: string
          nullable: true
        zipCode:
          type: string
          nullable: true
        city:
          type: string
          nullable: true
        district:
          type: string
          nullable: true
        region:
          type: string
          nullable: true
        country:
          type: string
          nullable: true
        email:
          type: string
          nullable: true
        mobile:
          type: string
          nullable: true
        fullAddress:
          type: string
          nullable: true
    NaturalPersonEconomicProfileResponse:
      type: object
      properties:
        mainBusinessActivities:
          type: string
          nullable: true
        sizeOfAnnualIncome:
          $ref: '#/components/schemas/eMoneyRange'
        sizeOfAnnualIncomeMin:
          type: number
          format: double
          nullable: true
        sizeOfAnnualIncomeMax:
          type: number
          format: double
          nullable: true
        mainSourceOfIncome:
          $ref: '#/components/schemas/eSourceOfIncomeAnswers'
        sizeOfWealth:
          $ref: '#/components/schemas/eWealthRange'
        sizeOfWealthMin:
          type: number
          format: double
          nullable: true
        sizeOfWealthMax:
          type: number
          format: double
          nullable: true
        isHnwi:
          type: boolean
        sourceOfWealth:
          $ref: '#/components/schemas/eSourceOfWealthAnswers'
        expectedOriginOfOutgoingFunds:
          type: string
          nullable: true
        expectedOriginOfIncomingFunds:
          type: string
          nullable: true
        natureOfTransaction:
          type: string
          nullable: true
        anticipatedAccountTurnOver:
          $ref: '#/components/schemas/eMoneyRange'
        anticipatedAccountTurnOverMin:
          type: number
          format: double
          nullable: true
        anticipatedAccountTurnOverMax:
          type: number
          format: double
          nullable: true
        purposeOfBusinessRelationship:
          type: string
          nullable: true
        industryNameOfHighestRisk:
          type: string
          nullable: true
        industryRiskOfHighestRisk:
          $ref: '#/components/schemas/eScore'
        creationDate:
          type: string
          format: date-time
        lastUpdatedDate:
          type: string
          format: date-time
    NaturalPersonFaceVerificationResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/eStatus'
        comment:
          type: string
          nullable: true
        rejectLabels:
          type: array
          items:
            $ref: '#/components/schemas/RejectLabelType'
          nullable: true
        faceMatchConfidence:
          type: number
          format: double
          nullable: true
        imageId:
          type: string
          nullable: true
        creationDate:
          type: string
          format: date-time
        lastUpdatedDate:
          type: string
          format: date-time
    NaturalPersonIdDocumentRequest:
      type: object
      properties:
        country:
          type: string
          nullable: true
        document:
          type: string
          nullable: true
        additionalDocument:
          type: string
          nullable: true
        documentType:
          $ref: '#/components/schemas/IDDocType'
        face:
          type: string
          nullable: true
        hasLivenessCheck:
          type: boolean
    NaturalPersonInfoResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
        clientReferenceId:
          type: string
          nullable: true
        creationDate:
          type: string
          format: date-time
        lastUpdatedDate:
          type: string
          format: date-time
        deletionDate:
          type: string
          format: date-time
          nullable: true
        taxId:
          type: string
          nullable: true
        firstName:
          type: string
          nullable: true
        lastName:
          type: string
          nullable: true
        middleName:
          type: string
          nullable: true
        legalName:
          type: string
          nullable: true
        dateOfBirth:
          type: string
          format: date-time
          nullable: true
        gender:
          $ref: '#/components/schemas/eGender'
        countryBirth:
          type: string
          nullable: true
        countryResidence:
          type: string
          nullable: true
        countryMainBusiness:
          type: string
          nullable: true
        nationality:
          type: string
          nullable: true
        email:
          type: string
          nullable: true
        emailTwo:
          type: string
          nullable: true
        mobilePhone:
          type: string
          nullable: true
        mobilePhoneTwo:
          type: string
          nullable: true
        automaticallyUpdateNPRisk:
          type: boolean
          nullable: true
        riskLevel:
          $ref: '#/components/schemas/eScore'
        riskLevelJustification:
          type: string
          nullable: true
        status:
          $ref: '#/components/schemas/eStatus'
        rejectLabels:
          type: array
          items:
            $ref: '#/components/schemas/RejectLabelType'
          nullable: true
        isFlagged:
          type: boolean
        comments:
          type: string
          nullable: true
        economicProfile:
          $ref: '#/components/schemas/NaturalPersonEconomicProfileResponse'
        documentVerification:
          $ref: '#/components/schemas/NaturalPersonDocumentVerificationResponse'
        addressVerification:
          $ref: '#/components/schemas/NaturalPersonAddressVerificationResponse'
        faceVerification:
          $ref: '#/components/schemas/NaturalPersonFaceVerificationResponse'
        screeningVerification:
          $ref: '#/components/schemas/NaturalPersonAmlVerificationResponse'
        otherSourcesOfIncome:
          type: array
          items:
            $ref: '#/components/schemas/NaturalPersonOtherSourceOfIncomeResponse'
          nullable: true
        otherSourcesOfWealth:
          type: array
          items:
            $ref: '#/components/schemas/NaturalPersonOtherSourceOfWealthResponse'
          nullable: true
        industries:
          type: array
          items:
            $ref: '#/components/schemas/NaturalPersonOccupationResponse'
          nullable: true
    NaturalPersonInfoResponseBaseResponse:
      type: object
      properties:
        errorCode:
          type: integer
          format: int32
        errorMessage:
          type: string
          nullable: true
        data:
          $ref: '#/components/schemas/NaturalPersonInfoResponse'
        succeeded:
          type: boolean
          readOnly: true
    NaturalPersonOccupationResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
          nullable: true
        riskLevel:
          $ref: '#/components/schemas/eScore'
    NaturalPersonOtherSourceOfIncomeResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
          nullable: true
    NaturalPersonOtherSourceOfWealthResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
          nullable: true
    NaturalPersonRequest:
      type: object
      properties:
        naturalPersonId:
          type: integer
          format: int64
          nullable: true
        firstName:
          type: string
          nullable: true
        middleName:
          type: string
          nullable: true
        lastName:
          type: string
          nullable: true
        dob:
          type: string
          format: date-time
        partialMatch:
          type: string
          nullable: true
        document:
          type: string
          nullable: true
        documentType:
          type: string
          nullable: true
    NaturalPersonResponse:
      type: object
      properties:
        info:
          $ref: '#/components/schemas/NaturalPersonInfoResponse'
    NaturalPersonResponseBaseResponse:
      type: object
      properties:
        errorCode:
          type: integer
          format: int32
        errorMessage:
          type: string
          nullable: true
        data:
          $ref: '#/components/schemas/NaturalPersonResponse'
        succeeded:
          type: boolean
          readOnly: true
    RejectLabelType:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
        - 8
        - 9
        - 10
        - 11
        - 12
        - 13
        - 14
        - 15
        - 16
        - 17
        - 18
        - 19
        - 20
        - 21
        - 22
        - 23
        - 24
        - 25
        - 26
        - 27
        - 28
        - 29
        - 30
        - 31
        - 32
        - 33
        - 34
        - 35
        - 36
        - 37
        - 38
        - 39
        - 40
        - 41
        - 42
        - 43
        - 44
        - 45
        - 46
        - 47
        - 48
        - 49
        - 50
        - 51
        - 52
        - 53
        - 54
      type: integer
      format: int32
    ShuftiAddressData:
      type: object
      properties:
        issueDate:
          type: string
          format: date-time
          nullable: true
        fullAddress:
          nullable: true
        name:
          $ref: '#/components/schemas/Name'
        selectedType:
          type: array
          items:
            type: string
          nullable: true
        supportedTypes:
          type: array
          items:
            type: string
          nullable: true
    ShuftiAddressDataResponse:
      type: object
      properties:
        info:
          $ref: '#/components/schemas/Info'
        reference:
          type: string
          nullable: true
        event:
          type: string
          nullable: true
        error:
          $ref: '#/components/schemas/Error'
        email:
          type: string
          nullable: true
        country:
          type: string
          nullable: true
        verificationData:
          $ref: '#/components/schemas/VerificationData'
        verificationResult:
          $ref: '#/components/schemas/VerificationResult'
        declinedReason:
          type: string
          nullable: true
        declinedCodes:
          type: array
          items:
            type: string
          nullable: true
    ShuftiAddressResultResponse:
      type: object
      properties:
        issueDate:
          type: boolean
          nullable: true
        selectedType:
          type: boolean
          nullable: true
        addressDocumentCountry:
          type: boolean
          nullable: true
        addressDocumentMustNotBeExpired:
          type: boolean
          nullable: true
        fullAddress:
          nullable: true
        name:
          nullable: true
        addressDocumentVisibility:
          type: boolean
          nullable: true
        addressDocument:
          type: boolean
          nullable: true
        addressDocumentProof:
          nullable: true
    SourceNote:
      type: object
      properties:
        amlTypes:
          type: array
          items:
            type: string
          nullable: true
        countryCodes:
          type: array
          items:
            type: string
          nullable: true
        name:
          type: string
          nullable: true
        url:
          type: string
          nullable: true
    StringBaseResponse:
      type: object
      properties:
        errorCode:
          type: integer
          format: int32
        errorMessage:
          type: string
          nullable: true
        data:
          type: string
          nullable: true
        succeeded:
          type: boolean
          readOnly: true
    SumSubAmlVerificationHitResponse:
      type: object
      properties:
        dataSourceName:
          type: string
          nullable: true
        categories:
          type: array
          items:
            type: string
          nullable: true
        name:
          type: string
          nullable: true
        country:
          type: string
          nullable: true
        politicalPositions:
          type: array
          items:
            type: string
          nullable: true
        relatedUrls:
          type: array
          items:
            type: string
          nullable: true
        birthDates:
          type: array
          items:
            type: string
          nullable: true
        matchTypes:
          type: array
          items:
            type: string
          nullable: true
        matchStatus:
          type: string
          nullable: true
    SumSubAmlVerificationResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/eStatus'
        categories:
          type: array
          items:
            type: string
          nullable: true
        hasSanctions:
          $ref: '#/components/schemas/eSanctionAnswers'
        isPep:
          $ref: '#/components/schemas/ePepAnswers'
        hasNegativeReputation:
          $ref: '#/components/schemas/eNegativeReputationAnswers'
        creationDate:
          type: string
          format: date-time
        hits:
          type: array
          items:
            $ref: '#/components/schemas/SumSubAmlVerificationHitResponse'
          nullable: true
    SumSubDocumentVerificationVerificationResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/eStatus'
        comment:
          type: string
          nullable: true
        rejectLabels:
          type: array
          items:
            $ref: '#/components/schemas/RejectLabelType'
          nullable: true
        creationDate:
          type: string
          format: date-time
        verificationId:
          type: integer
          format: int64
          nullable: true
        imageId:
          type: string
          nullable: true
        additionalImageId:
          type: string
          nullable: true
    SumSubVerificationResponse:
      type: object
      properties:
        creationDate:
          type: string
          format: date-time
        screening:
          $ref: '#/components/schemas/SumSubAmlVerificationResponse'
        idDocument:
          $ref: '#/components/schemas/SumSubDocumentVerificationVerificationResponse'
        face:
          $ref: '#/components/schemas/SumSubDocumentVerificationVerificationResponse'
        addressDocument:
          $ref: '#/components/schemas/SumSubDocumentVerificationVerificationResponse'
    SumSubVerificationResponseBaseResponse:
      type: object
      properties:
        errorCode:
          type: integer
          format: int32
        errorMessage:
          type: string
          nullable: true
        data:
          $ref: '#/components/schemas/SumSubVerificationResponse'
        succeeded:
          type: boolean
          readOnly: true
    SumSubVerificationResponseListBaseResponse:
      type: object
      properties:
        errorCode:
          type: integer
          format: int32
        errorMessage:
          type: string
          nullable: true
        data:
          type: array
          items:
            $ref: '#/components/schemas/SumSubVerificationResponse'
          nullable: true
        succeeded:
          type: boolean
          readOnly: true
    UpdateNaturalPersonDocumentsDataSaveResult:
      type: object
      properties:
        idDocumentSaved:
          $ref: '#/components/schemas/BaseResponse'
        faceSaved:
          $ref: '#/components/schemas/BaseResponse'
        livenessCheckURL:
          $ref: '#/components/schemas/StringBaseResponse'
        addressDocumentSaved:
          $ref: '#/components/schemas/BaseResponse'
        verificationStarted:
          $ref: '#/components/schemas/BaseResponse'
        allSucceeded:
          type: boolean
          readOnly: true
    UpdateNaturalPersonDocumentsResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
        clientReferenceId:
          type: string
          nullable: true
        dataSaveResponses:
          $ref: '#/components/schemas/UpdateNaturalPersonDocumentsDataSaveResult'
        verification:
          $ref: '#/components/schemas/SumSubVerificationResponse'
        documentImages:
          $ref: '#/components/schemas/DocumentImages'
    UpdateNaturalPersonDocumentsResponseBaseResponse:
      type: object
      properties:
        errorCode:
          type: integer
          format: int32
        errorMessage:
          type: string
          nullable: true
        data:
          $ref: '#/components/schemas/UpdateNaturalPersonDocumentsResponse'
        succeeded:
          type: boolean
          readOnly: true
    UpdateNaturalPersonEconomicProfileRequest:
      type: object
      properties:
        mainBusinessActivities:
          type: string
          nullable: true
        sizeOfAnnualIncome:
          $ref: '#/components/schemas/eMoneyRange'
        sizeOfAnnualIncomeMin:
          type: number
          format: double
          nullable: true
        sizeOfAnnualIncomeMax:
          type: number
          format: double
          nullable: true
        mainSourceOfIncome:
          $ref: '#/components/schemas/eSourceOfIncomeAnswers'
        sizeOfWealth:
          $ref: '#/components/schemas/eWealthRange'
        sizeOfWealthMin:
          type: number
          format: double
          nullable: true
        sizeOfWealthMax:
          type: number
          format: double
          nullable: true
        isHnwi:
          type: boolean
        sourceOfWealth:
          $ref: '#/components/schemas/eSourceOfWealthAnswers'
        expectedOriginOfOutgoingFunds:
          type: string
          nullable: true
        expectedOriginOfIncomingFunds:
          type: string
          nullable: true
        natureOfTransaction:
          type: string
          nullable: true
        anticipatedAccountTurnOver:
          $ref: '#/components/schemas/eMoneyRange'
        anticipatedAccountTurnOverMin:
          type: number
          format: double
          nullable: true
        anticipatedAccountTurnOverMax:
          type: number
          format: double
          nullable: true
        purposeOfBusinessRelationship:
          type: string
          nullable: true
    UpdateNaturalPersonInfoRequest:
      type: object
      properties:
        clientReferenceId:
          type: string
          nullable: true
        taxId:
          type: string
          nullable: true
        firstName:
          type: string
          nullable: true
        lastName:
          type: string
          nullable: true
        middleName:
          type: string
          nullable: true
        legalName:
          type: string
          nullable: true
        dateOfBirth:
          type: string
          format: date-time
          nullable: true
        gender:
          $ref: '#/components/schemas/eGender'
        countryBirth:
          type: string
          nullable: true
        countryResidence:
          type: string
          nullable: true
        countryMainBusiness:
          type: string
          nullable: true
        nationality:
          type: string
          nullable: true
        email:
          type: string
          nullable: true
        emailTwo:
          type: string
          nullable: true
        mobilePhone:
          type: string
          nullable: true
        mobilePhoneTwo:
          type: string
          nullable: true
        automaticallyUpdateNPRisk:
          type: boolean
          nullable: true
        riskLevel:
          $ref: '#/components/schemas/eScore'
        riskLevelJustification:
          type: string
          nullable: true
        isFlagged:
          type: boolean
        comments:
          type: string
          nullable: true
        economicProfile:
          $ref: '#/components/schemas/UpdateNaturalPersonEconomicProfileRequest'
    VerificationData:
      type: object
      properties:
        address:
          $ref: '#/components/schemas/ShuftiAddressData'
    VerificationResult:
      type: object
      properties:
        address:
          $ref: '#/components/schemas/ShuftiAddressResultResponse'
    eGender:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
        - 8
        - 9
        - 10
        - 11
        - 12
      type: integer
      format: int32
    eMoneyRange:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - -1
      type: integer
      format: int32
    eNegativeReputationAnswers:
      enum:
        - 0
        - 1
        - 2
        - 3
      type: integer
      format: int32
    ePepAnswers:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
      type: integer
      format: int32
    eSanctionAnswers:
      enum:
        - 0
        - 1
        - 2
      type: integer
      format: int32
    eScore:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - -5
        - -4
        - -3
        - -2
        - -1
      type: integer
      format: int32
    eSourceOfIncomeAnswers:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
        - -1
      type: integer
      format: int32
    eSourceOfWealthAnswers:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
        - 8
        - 9
        - 10
        - 11
        - 12
        - 13
        - 14
        - 15
        - 16
        - 17
        - -1
      type: integer
      format: int32
    eStatus:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - -2
        - -1
      type: integer
      format: int32
    eVerificationType:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
      type: integer
      format: int32
    eWealthRange:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
        - -1
      type: integer
      format: int32
    AddressVerifyCertificatePdfResponse:
      type: string
      format: binary
    AddressVerifyCertificatePdf401Response:
      type: string
      format: binary
    AddressVerifyCertificatePdf404Response:
      type: string
      format: binary
    DocumentGetCertificateResponse:
      type: string
      format: binary
    DocumentGetCertificate401Response:
      type: string
      format: binary
    DocumentGetCertificate404Response:
      type: string
      format: binary
    NaturalPersonGetCertificateResponse:
      type: string
      format: binary
    NaturalPersonGetCertificate200Response:
      type: string
      format: binary
    NaturalPersonGetCertificate401Response:
      type: string
      format: binary
    NaturalPersonGetCertificate404Response:
      type: string
      format: binary
    NaturalPersonGetCertificate500Response:
      type: string
      format: binary
  securitySchemes:
    Bearer:
      description: JWT Authorization header using the Bearer scheme.
      type: apiKey
      name: Authorization
      in: header
security:
  - Bearer: []