iDenfy Webhooks API

openapi: 3.2.0
info:
  title: Idenfy Webhooks API
  version: 0.0.0
  contact:
    name: API Support
    url: https://idenfy-ivs.atlassian.net/servicedesk/customer/portal/1/group/-1
  x-logo:
    url: /static/idenfy_logo.svg
    altText: iDenfy logo
  description: 'Operations tagged Webhooks across 7 of this provider''s published API definitions: idenfy-age-estimation-openapi.yml, idenfy-aml-openapi.yml, idenfy-bank-card-openapi.yml, idenfy-bank-openapi.yml, idenfy-face-authentication-openapi.yml, idenfy-kyb-openapi.yml, idenfy-kyc-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://ivs.idenfy.com
tags:
- name: Webhooks
  description: Webhooks.
paths: {}
webhooks:
  ageEstimationResult:
    post:
      operationId: ageEstimationResult
      description: This notification is sent when an age estimation session reaches a terminal state (either the estimate resolved, or a document step-up concluded).
      summary: Age estimation result
      externalDocs:
        description: Find info about webhook signing here.
        url: https://documentation.idenfy.com/security/CallbackSigning
      parameters:
      - in: header
        name: Idenfy-Event-Type
        schema:
          type: string
          enum:
          - AGE_ESTIMATION
        required: true
      - in: header
        name: Idenfy-Signature
        schema:
          type: string
        description: Webhook signature
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgeEstimationWebhook'
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
    servers:
    - url: https://ivs.idenfy.com
  amlMonitoring:
    post:
      operationId: amlMonitoring
      description: This notification is sent when an AML monitoring user is checked, accepted or declined.
      summary: Aml monitoring
      externalDocs:
        description: Find info about webhook signing here.
        url: https://documentation.idenfy.com/security/CallbackSigning
      parameters:
      - in: header
        name: Idenfy-Event-Type
        schema:
          type: string
          enum:
          - AML_MONITORING
        required: true
      - in: header
        name: Idenfy-Signature
        schema:
          type: string
        description: Webhook signature
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AmlMonitoringWebhook'
        required: true
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
    servers:
    - url: https://ivs.idenfy.com
  amlMonitoringExpiration:
    post:
      operationId: amlMonitoringExpiration
      description: This notification is sent when an AML monitoring user is nearing expiration or expires.
      summary: Aml monitoring expiration
      externalDocs:
        description: Find info about webhook signing here.
        url: https://documentation.idenfy.com/security/CallbackSigning
      parameters:
      - in: header
        name: Idenfy-Event-Type
        schema:
          type: string
          enum:
          - AML_MONITORING_EXPIRATION
        required: true
      - in: header
        name: Idenfy-Signature
        schema:
          type: string
        description: Webhook signature
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AmlMonitoringExpirationWebhook'
        required: true
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
    servers:
    - url: https://ivs.idenfy.com
  bankCardVerificationCompleted:
    post:
      operationId: bankCardVerificationCompleted
      description: This notification is sent when a bank card verification is completed.
      summary: Bank card verification completed
      externalDocs:
        description: Find info about webhook signing here.
        url: https://documentation.idenfy.com/security/CallbackSigning
      parameters:
      - in: header
        name: Idenfy-Event-Type
        schema:
          type: string
          enum:
          - BANK_CARD_VERIFICATION_COMPLETED
        required: true
      - in: header
        name: Idenfy-Signature
        schema:
          type: string
        description: Webhook signature
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BankCardVerificationWebhook'
        required: true
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
    servers:
    - url: https://ivs.idenfy.com
  bankVerification:
    post:
      operationId: bankVerification
      description: This notification is sent when a bank verification is completed.
      summary: Bank verification
      externalDocs:
        description: Find info about webhook signing here.
        url: https://documentation.idenfy.com/security/CallbackSigning
      parameters:
      - in: header
        name: Idenfy-Event-Type
        schema:
          type: string
          enum:
          - BANK_VERIFICATION
        required: true
      - in: header
        name: Idenfy-Signature
        schema:
          type: string
        description: Webhook signature
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BankVerificationWebhook'
        required: true
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
    servers:
    - url: https://ivs.idenfy.com
  accountCheck:
    post:
      operationId: accountCheck
      description: This notification is sent when an account social media check is completed.
      summary: Account check
      externalDocs:
        description: Find info about webhook signing here.
        url: https://documentation.idenfy.com/security/CallbackSigning
      parameters:
      - in: header
        name: Idenfy-Event-Type
        schema:
          type: string
          enum:
          - ACCOUNT_CHECK
        required: true
      - in: header
        name: Idenfy-Signature
        schema:
          type: string
        description: Webhook signature
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountCheckWebhook'
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
    servers:
    - url: https://ivs.idenfy.com
  facialAuthentication:
    post:
      operationId: facialAuthentication
      description: This notification is sent when client's facial authentication session ends, either by success, failure or expiration.
      summary: Facial authentication
      externalDocs:
        description: Find info about webhook signing here.
        url: https://documentation.idenfy.com/security/CallbackSigning
      parameters:
      - in: header
        name: Idenfy-Event-Type
        schema:
          type: string
          enum:
          - FACIAL_AUTHENTICATION
        required: true
      - in: header
        name: Idenfy-Signature
        schema:
          type: string
        description: Webhook signature
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FacialAuthenticationWebhook'
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
    servers:
    - url: https://ivs.idenfy.com
  companyReview:
    post:
      operationId: companyReview
      description: This notification is sent when a company verification is completed.
      summary: Company review
      externalDocs:
        description: Find info about webhook signing here.
        url: https://documentation.idenfy.com/security/CallbackSigning
      parameters:
      - in: header
        name: Idenfy-Event-Type
        schema:
          type: string
          enum:
          - COMPANY_REVIEW
        required: true
      - in: header
        name: Idenfy-Signature
        schema:
          type: string
        description: Webhook signature
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyReviewWebhook'
        required: true
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
    servers:
    - url: https://ivs.idenfy.com
  companyDelete:
    post:
      operationId: companyDelete
      description: This notification is sent when a company is deleted.
      summary: Company delete
      externalDocs:
        description: Find info about webhook signing here.
        url: https://documentation.idenfy.com/security/CallbackSigning
      parameters:
      - in: header
        name: Idenfy-Event-Type
        schema:
          type: string
          enum:
          - COMPANY_DELETE
        required: true
      - in: header
        name: Idenfy-Signature
        schema:
          type: string
        description: Webhook signature
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyDeleteWebhook'
        required: true
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
    servers:
    - url: https://ivs.idenfy.com
  companyAmlReview:
    post:
      operationId: companyAmlReview
      description: This notification is sent when an AML review status is manually updated for a company or it's beneficiaries.
      summary: Company aml review
      externalDocs:
        description: Find info about webhook signing here.
        url: https://documentation.idenfy.com/security/CallbackSigning
      parameters:
      - in: header
        name: Idenfy-Event-Type
        schema:
          type: string
          enum:
          - COMPANY_AML_REVIEW
        required: true
      - in: header
        name: Idenfy-Signature
        schema:
          type: string
        description: Webhook signature
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AmlReviewWebhook'
        required: true
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
    servers:
    - url: https://ivs.idenfy.com
  companyInfoRequest:
    post:
      operationId: companyInfoRequest
      description: This notification is sent when additional company info is requested and when the company form token expires.
      summary: Company info request
      externalDocs:
        description: Find info about webhook signing here.
        url: https://documentation.idenfy.com/security/CallbackSigning
      parameters:
      - in: header
        name: Idenfy-Event-Type
        schema:
          type: string
          enum:
          - COMPANY_INFO_REQUEST
        required: true
      - in: header
        name: Idenfy-Signature
        schema:
          type: string
        description: Webhook signature
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyInfoRequestWebhook'
        required: true
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
    servers:
    - url: https://ivs.idenfy.com
  companyExpiration:
    post:
      operationId: companyExpiration
      description: This notification is sent when a company verification is nearing expiration or expires.
      summary: Company expiration
      externalDocs:
        description: Find info about webhook signing here.
        url: https://documentation.idenfy.com/security/CallbackSigning
      parameters:
      - in: header
        name: Idenfy-Event-Type
        schema:
          type: string
          enum:
          - COMPANY_EXPIRATION
        required: true
      - in: header
        name: Idenfy-Signature
        schema:
          type: string
        description: Webhook signature
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyExpirationWebhook'
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
    servers:
    - url: https://ivs.idenfy.com
  companySubmit:
    post:
      operationId: companySubmit
      description: This notification is sent when company information is submitted.
      summary: Company submit
      externalDocs:
        description: Find info about webhook signing here.
        url: https://documentation.idenfy.com/security/CallbackSigning
      parameters:
      - in: header
        name: Idenfy-Event-Type
        schema:
          type: string
          enum:
          - COMPANY_SUBMIT
        required: true
      - in: header
        name: Idenfy-Signature
        schema:
          type: string
        description: Webhook signature
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanySubmitWebhook'
        required: true
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
    servers:
    - url: https://ivs.idenfy.com
  govOrderedDocument:
    post:
      operationId: govOrderedDocument
      description: This notification is sent when a gov registers document, which was ordered using the API, is delivered.
      summary: Gov ordered document
      externalDocs:
        description: Find info about webhook signing here.
        url: https://documentation.idenfy.com/security/CallbackSigning
      parameters:
      - in: header
        name: Idenfy-Event-Type
        schema:
          type: string
          enum:
          - GOV_ORDERED_DOCUMENT
        required: true
      - in: header
        name: Idenfy-Signature
        schema:
          type: string
        description: Webhook signature
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GovPartnerOrderedDocument'
        required: true
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
    servers:
    - url: https://ivs.idenfy.com
  sosReport:
    post:
      operationId: sosReport
      description: This notification is sent when a SOS filing report is delivered.
      summary: Sos report
      externalDocs:
        description: Find info about webhook signing here.
        url: https://documentation.idenfy.com/security/CallbackSigning
      parameters:
      - in: header
        name: Idenfy-Event-Type
        schema:
          type: string
          enum:
          - SOS_REPORT
        required: true
      - in: header
        name: Idenfy-Signature
        schema:
          type: string
        description: Webhook signature
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SosReportWebhook'
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
    servers:
    - url: https://ivs.idenfy.com
  identification:
    post:
      operationId: identification
      description: This notification is sent when a client completes an identity verification. Legacy, use `ID_VERIFICATION_AUTO_FINISHED`, `ID_VERIFICATION_MANUAL_FINISHED`, `ID_VERIFICATION_EXPIRED` and `ID_VERIFICATION_CANCELLED` instead.
      summary: Identification
      externalDocs:
        description: Find info about webhook signing here.
        url: https://documentation.idenfy.com/security/CallbackSigning
      parameters:
      - in: header
        name: Idenfy-Event-Type
        schema:
          type: string
          enum:
          - IDENTIFICATION
        required: true
      - in: header
        name: Idenfy-Signature
        schema:
          type: string
        description: Webhook signature
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentificationWebhook'
        required: true
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
    servers:
    - url: https://ivs.idenfy.com
  identificationAutoFinished:
    post:
      operationId: identificationAutoFinished
      description: This notification is sent when an identity verification is completed.
      summary: Identification auto finished
      externalDocs:
        description: Find info about webhook signing here.
        url: https://documentation.idenfy.com/security/CallbackSigning
      parameters:
      - in: header
        name: Idenfy-Event-Type
        schema:
          type: string
          enum:
          - IDENTIFICATION_AUTO_FINISHED
        required: true
      - in: header
        name: Idenfy-Signature
        schema:
          type: string
        description: Webhook signature
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentificationWebhook'
        required: true
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
    servers:
    - url: https://ivs.idenfy.com
  identificationManualFinished:
    post:
      operationId: identificationManualFinished
      description: This notification is sent when an identity verification is manually approved or denied.
      summary: Identification manual finished
      externalDocs:
        description: Find info about webhook signing here.
        url: https://documentation.idenfy.com/security/CallbackSigning
      parameters:
      - in: header
        name: Idenfy-Event-Type
        schema:
          type: string
          enum:
          - IDENTIFICATION_MANUAL_FINISHED
        required: true
      - in: header
        name: Idenfy-Signature
        schema:
          type: string
        description: Webhook signature
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentificationWebhook'
        required: true
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
    servers:
    - url: https://ivs.idenfy.com
  identificationExpired:
    post:
      operationId: identificationExpired
      description: This notification is sent when an identity verification expires.
      summary: Identification expired
      externalDocs:
        description: Find info about webhook signing here.
        url: https://documentation.idenfy.com/security/CallbackSigning
      parameters:
      - in: header
        name: Idenfy-Event-Type
        schema:
          type: string
          enum:
          - IDENTIFICATION_EXPIRED
        required: true
      - in: header
        name: Idenfy-Signature
        schema:
          type: string
        description: Webhook signature
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentificationWebhook'
        required: true
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
    servers:
    - url: https://ivs.idenfy.com
  identificationCancelled:
    post:
      operationId: identificationCancelled
      description: This notification is sent when an identity verification is cancelled by the user or the system.
      summary: Identification cancelled
      externalDocs:
        description: Find info about webhook signing here.
        url: https://documentation.idenfy.com/security/CallbackSigning
      parameters:
      - in: header
        name: Idenfy-Event-Type
        schema:
          type: string
          enum:
          - IDENTIFICATION_CANCELLED
        required: true
      - in: header
        name: Idenfy-Signature
        schema:
          type: string
        description: Webhook signature
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentificationWebhook'
        required: true
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
    servers:
    - url: https://ivs.idenfy.com
  identificationResubmitted:
    post:
      operationId: identificationResubmitted
      description: This notification is sent when a client resubmits an identity verification.
      summary: Identification resubmitted
      externalDocs:
        description: Find info about webhook signing here.
        url: https://documentation.idenfy.com/security/CallbackSigning
      parameters:
      - in: header
        name: Idenfy-Event-Type
        schema:
          type: string
          enum:
          - IDENTIFICATION_RESUBMITTED
        required: true
      - in: header
        name: Idenfy-Signature
        schema:
          type: string
        description: Webhook signature
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentificationWebhook'
        required: true
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
    servers:
    - url: https://ivs.idenfy.com
  documentExpiration:
    post:
      operationId: documentExpiration
      description: This notification is sent when a client's identity verification document is nearing expiration or expires
      summary: Document expiration
      externalDocs:
        description: Find info about webhook signing here.
        url: https://documentation.idenfy.com/security/CallbackSigning
      parameters:
      - in: header
        name: Idenfy-Event-Type
        schema:
          type: string
          enum:
          - DOCUMENT_EXPIRATION
        required: true
      - in: header
        name: Idenfy-Signature
        schema:
          type: string
        description: Webhook signature
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentExpirationWebhook'
        required: true
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
    servers:
    - url: https://ivs.idenfy.com
  videoCallFinished:
    post:
      operationId: videoCallFinished
      description: This notification is sent when a video call is finished.
      summary: Video call finished
      externalDocs:
        description: Find info about webhook signing here.
        url: https://documentation.idenfy.com/security/CallbackSigning
      parameters:
      - in: header
        name: Idenfy-Event-Type
        schema:
          type: string
          enum:
          - VIDEO_CALL_FINISHED
        required: true
      - in: header
        name: Idenfy-Signature
        schema:
          type: string
        description: Webhook signature
      tags:
      - Webhooks
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
    servers:
    - url: https://ivs.idenfy.com
components:
  schemas:
    AgeEstimationWebhookStatusEnum:
      enum:
      - COMPLETED
      - FAILED
      type: string
    AgeEstimationWebhook:
      type: object
      properties:
        scanRef:
          type: string
          description: The step-up scan reference, or the token id when there is no scan ref.
        status:
          $ref: '#/components/schemas/AgeEstimationWebhookStatusEnum'
        outcome:
          allOf:
          - $ref: '#/components/schemas/AgeEstimationOutcomeEnum'
          nullable: true
        verdict:
          type: string
          nullable: true
          description: Model verdict (e.g. `ADULT`).
        estimatedAge:
          type: integer
          nullable: true
          description: The established age. When a document step-up produced an age, that exact document age is reported; otherwise it is the AI face-estimated age.
        confidence:
          type: number
          format: float
          nullable: true
        clientId:
          type: string
          nullable: true
        occurredAt:
          type: string
          format: date-time
      required:
      - scanRef
      - status
      - occurredAt
    AgeEstimationOutcomeEnum:
      enum:
      - SUCCESS
      - UNDERAGE
      - UNCERTAIN
      - FACE_MISMATCH
      - ATTEMPTS_EXCEEDED
      type: string
    AmlMonitoringExpirationWebhook:
      type: object
      properties:
        usersToExtend:
          type: integer
        usersToExpire:
          type: integer
      required:
      - usersToExpire
      - usersToExtend
    ManagerAccount:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 100
        surname:
          type: string
          maxLength: 100
        email:
          type: string
          format: email
          maxLength: 254
      required:
      - email
      - id
      - name
      - surname
    BusinessSearchDatasetEnum:
      enum:
      - PEP
      - PEP_LINKED
      - SAN
      - SAN_CURRENT
      - SAN_FORMER
      - INS
      - RRE
      - POI
      - REL
      - SOE
      - SOE_CURRENT
      - SOE_FORMER
      type: string
    MonitoringStatusEnum:
      enum:
      - ACTIVE
      - STOPPED
      - PENDING
      - ALERT
      type: string
    AmlNewsResults:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/FraudStatus'
        serviceName:
          type: string
        serviceGroupType:
          type: string
        uid:
          type: string
        errorMessage:
          type: string
          nullable: true
        data:
          type: array
          items:
            $ref: '#/components/schemas/AdverseMediaData'
      required:
      - errorMessage
      - serviceGroupType
      - serviceName
      - status
      - uid
    CountryEnum:
      enum:
      - AF
      - AX
      - AL
      - DZ
      - AS
      - AD
      - AO
      - AI
      - AQ
      - AG
      - AR
      - AM
      - AW
      - AU
      - AT
      - AZ
      - BS
      - BH
      - BD
      - BB
      - BY
      - BE
      - BZ
      - BJ
      - BM
      - BT
      - BO
      - BQ
      - BA
      - BW
      - BV
      - BR
      - IO
      - BN
      - BG
      - BF
      - BI
      - CV
      - KH
      - CM
      - CA
      - KY
      - CF
      - TD
      - CL
      - CN
      - CX
      - CC
      - CO
      - KM
      - CG
      - CK
      - CR
      - CI
      - HR
      - CU
      - CW
      - CY
      - CZ
      - CD
      - DK
      - DJ
      - DM
      - DO
      - EC
      - EG
      - SV
      - GQ
      - ER
      - EE
      - SZ
      - ET
      - FK
      - FO
      - FJ
      - FI
      - FR
      - GF
      - PF
      - TF
      - GA
      - GM
      - GE
      - DE
      - GH
      - GI
      - GR
      - GL
      - GD
      - GP
      - GU
      - GT
      - GG
      - GN
      - GW
      - GY
      - HT
      - HM
      - HN
      - HK
      - HU
      - IS
      - IN
      - ID
      - IR
      - IQ
      - IE
      - IM
      - IL
      - IT
      - JM
      - JP
      - JE
      - JO
      - KZ
      - KE
      - KI
      - XK
      - KW
      - KG
      - LA
      - LV
      - LB
      - LS
      - LR
      - LY
      - LI
      - LT
      - LU
      - MO
      - MG
      - MW
      - MY
      - MV
      - ML
      - MT
      - MH
      - MQ
      - MR
      - MU
      - YT
      - MX
      - FM
      - MD
      - MC
      - MN
      - ME
      - MS
      - MA
      - MZ
      - MM
      - NA
      - NR
      - NP
      - NL
      - NC
      - NZ
      - NI
      - NE
      - NG
      - NU
      - NF
      - KP
      - MK
      - MP
      - 'NO'
      - OM
      - PK
      - PW
      - PS
      - PA
      - PG
      - PY
      - PE
      - PH
      - PN
      - PL
      - PT
      - PR
      - QA
      - RE
      - RO
      - RU
      - RW
      - BL
      - SH
      - KN
      - LC
      - MF
      - PM
      - VC
      - WS
      - SM
      - ST
      - SA
      - SN
      - RS
      - SC
      - SL
      - SG
      - SX
      - SK
      - SI
      - SB
      - SO
      - ZA
      - GS
      - KR
      - SS
      - ES
      - LK
      - SD
      - SR
      - SJ
      - SE
      - CH
      - SY
      - TW
      - TJ
      - TZ
      - TH
      - TL
      - TG
      - TK
      - TO
      - TT
      - TN
      - TR
      - TM
      - TC
      - TV
      - UG
      - UA
      - AE
      - GB
      - UM
      - US
      - UY
      - UZ
      - VU
      - VA
      - VE
      - VN
      - VG
      - VI
      - WF
      - EH
      - YE
      - ZM
      - ZW
      type: string
    AmlResults:
      oneOf:
      - $ref: '#/components/schemas/AmlNameResults'
      - $ref: '#/components/schemas/AmlNameResults'
      - $ref: '#/components/schemas/AmlCompanyNameResults'
      - $ref: '#/components/schemas/AmlNewsResults'
      - $ref: '#/components/schemas/AmlNewsResults'
      discriminator:
        propertyName: serviceName
        mapping:
          AML_NAMES_CHECK: '#/components/schemas/AmlNameResults'
          AML_OPEN_SANCTIONS: '#/components/schemas/AmlNameResults'
          COMPANY_CHECK: '#/components/schemas/AmlCompanyNameResults'
          AML_NEWS: '#/components/schemas/AmlNewsResults'
          INHOUSE_ADVERSE_MEDIA: '#/components/schemas/AmlNewsResults'
    AmlCheckStatusEnum:
      enum:
      - NOT_CHECKED
      - NO_FLAGS
      - FALSE_POSITIVE
      - TRUE_POSITIVE
      - FLAGS_FOUND
      type: string
    AmlData:
      type: object
      properties:
        name:
          type: string
          nullable: true
        surname:
          type: string
          nullable: true
        nationality:
          type: string
          nullable: true
        dob:
          type: string
          nullable: true
        suspicion:
          allOf:
          - $ref: '#/components/schemas/AmlSuspicionTypeEnum'
          nullable: true
        reason:
          type: string
          nullable: true
        listNumber:
          type: string
          nullable: true
        listName:
          type: string
          nullable: true
        score:
          type: integer
          nullable: true
        lastUpdate:
          type: string
          nullable: true
        exitDate:
          type: string
          nullable: true
        isPerson:
          type: boolean
          nullable: true
        isActive:
          type: boolean
          nullable: true
        linkedDocument:
          type: string
          format: uri
          nullable: true
        pepLevel:
          type: integer
          nullable: true
        category:
          type: string
          nullable: true
        otherInformation:
          type: string
          nullable: true
        checkDate:
          type: string
          nullable: true
        whitelisted:
          type: boolean
      required:
      - category
      - checkDate
      - dob
      - exitDate
      - isActive
      - isPerson
      - lastUpdate
      - linkedDocument
      - listName
      - listNumber
      - name
      - nationality
      - otherInformation
      - pep

# --- truncated at 32 KB (101 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/idenfy/refs/heads/main/openapi/idenfy-webhooks-api-openapi.yml