Sigma360 One-Off Screening API

openapi: 3.2.0
info:
  contact:
    email: support@sigma360.com
    name: Sigma Customer Success Team
  description: '### API Concepts

    This API is designed to help you interact and integrate with Sigma360.'
  title: Sigma360 One-Off Screening API
  version: v2.0.1
  x-logo:
    altText: Sigma360
    href: https://sigma360.com
    url: logo.png
servers:
- url: https://api.sigma360.com/external/v2
security:
- apiKey: []
tags:
- description: Screening against Sigma360's risk data
  name: One-Off Screening
paths:
  /screening/full-single:
    post:
      description: This endpoint is used to perform a screen of a single entity. It is done synchronously and returns a summary of the results. You must specify a filter set, which will be used for this search. The fields, coverage, and match threshold are determined by the filterset.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestFullSingleScreeningRequestPublic'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseFullSearchResultWithAlertPubliclyDocumented'
          description: OK
        '400':
          content:
            text/plain:
              schema:
                type: string
          description: Bad Request
        '401':
          content:
            text/plain:
              schema:
                type: string
          description: Unauthorized
        '429':
          content:
            text/plain:
              schema:
                type: string
          description: Too Many Requests
        '500':
          content:
            text/plain:
              schema:
                type: string
          description: Internal Server Error
      security:
      - apiKey: []
      summary: Real-time Single Screening
      tags:
      - One-Off Screening
      operationId: postScreeningFullSingle
      x-operation-id-source: derived
components:
  schemas:
    SigmaidExtractEntity:
      properties:
        entityRisk:
          description: 'A measure of how culpable or involved the entity is in the event, based on the article text. Possible values are: ''Very High'', ''High'', ''Possible'', ''Low'', ''Unlikely'', and ''Undetermined''.'
          type: string
        focalEntity:
          description: Marks if this extracted entity is the main entity of its event. Events have one focal entity, but articles may appear in different events with different focal entities.'
          type: boolean
        highlights:
          description: Offsets of where the entity appears in the article body or title
          items:
            $ref: '#/components/schemas/SigmaidHighLightSection'
          type: array
        labels:
          description: 'Predicted entity types: PER, ORG, LOC, or MISC.'
          items:
            type: string
          nullable: true
          type: array
        text:
          description: The entity name detected in the article body
          type: string
        yearsOfBirth:
          description: Birthdays of entities, if detected. This is a list of years, not a range.
          items:
            type: integer
          nullable: true
          type: array
      type: object
    SigmaidFullEntityFacet:
      properties:
        aircraft:
          $ref: '#/components/schemas/SigmaidFacetAircraft'
        company:
          $ref: '#/components/schemas/SigmaidFacetCompany'
        person:
          $ref: '#/components/schemas/SigmaidFacetPerson'
        type:
          type: integer
        vessel:
          $ref: '#/components/schemas/SigmaidFacetVessel'
      type: object
    SigmaidCustomEntityField:
      properties:
        key:
          type: string
        value:
          type: string
      type: object
    SigmaidFacetCompany:
      properties:
        corporateNumbers:
          items:
            $ref: '#/components/schemas/SigmaidCorporateNumber'
          nullable: true
          type: array
        economicActivities:
          additionalProperties:
            items:
              $ref: '#/components/schemas/SigmaidEconomicActivity'
            type: array
          nullable: true
          type: object
        foundedDates:
          items:
            $ref: '#/components/schemas/SigmaidDateWithSource'
          nullable: true
          type: array
        incorporationTypes:
          items:
            $ref: '#/components/schemas/SigmaidTextWithSource'
          nullable: true
          type: array
        linesOfBusiness:
          items:
            $ref: '#/components/schemas/SigmaidTextWithSource'
          nullable: true
          type: array
        statuses:
          items:
            $ref: '#/components/schemas/SigmaidTextWithSource'
          nullable: true
          type: array
      type: object
    SigmaidHighLightSection:
      properties:
        end:
          description: The end of the detected entity name in the article. Relative to the beginning of the text.
          type: integer
        start:
          description: The beginning offset of the detected entity name in the article. Relative to the beginning of the text.
          type: integer
        target:
          description: Determines whether the offsets should be applied to the title or body.
          enum:
          - title
          - body
          type: string
      type: object
    SigmaidNode:
      properties:
        entity:
          $ref: '#/components/schemas/SigmaidSummarySearchResultRow'
        entityType:
          description: The type of the entity (e.g. person, company, vessel, aircraft).
          type: string
        id:
          description: The SigmaID of the entity represented by this node.
          type: string
        isDisabled:
          description: Whether the node is disabled due to filters or other factors. However, it may still be included because it is required to show a further node.
          type: boolean
        name:
          description: The SigmaID's canonical name.
          type: string
      type: object
    SigmaidPoliticalPosition:
      properties:
        country:
          type: string
        description:
          type: string
        from:
          nullable: true
          type: string
        sourceAttribution:
          description: Not human readable. This can be used to look up against source information objects.
          items:
            example: abcd1234//1234567890
            type: string
          nullable: true
          type: array
        to:
          nullable: true
          type: string
      type: object
    SigmaidRelationshipChain:
      properties:
        edges:
          items:
            $ref: '#/components/schemas/SigmaidEdge'
          nullable: true
          type: array
        entities:
          items:
            $ref: '#/components/schemas/SigmaidBasicEntityResult'
          nullable: true
          type: array
      type: object
    SigmaidCompositeResult:
      properties:
        entity:
          $ref: '#/components/schemas/SigmaidEntityResult'
        matchDOB:
          type: string
        matchLocation:
          type: string
        matchName:
          example: InGen Corporation
          type: string
        matchStrength:
          example: 0.95
          type: number
        networkRiskSummary:
          $ref: '#/components/schemas/SigmaidNetworkRiskResult'
        sources:
          items:
            $ref: '#/components/schemas/SigmaidSourcesByIntegration'
          nullable: true
          type: array
      required:
      - entity
      type: object
    SigmaidSourcesByIntegration:
      properties:
        key:
          type: string
        lastUpdated:
          format: date-time
          nullable: true
          type: string
        matches:
          items:
            type: string
          nullable: true
          type: array
        matchesOriginated:
          type: integer
        name:
          type: string
        ultimateSources:
          items:
            type: string
          nullable: true
          type: array
      type: object
    SigmaidSummarySearchResultRow:
      properties:
        aliases:
          items:
            example: InGen, InGen Corp
            type: string
          nullable: true
          type: array
        birthDates:
          description: Birth dates of the entity
          items:
            $ref: '#/components/schemas/SigmaidDateWithSource'
          nullable: true
          type: array
        entityName:
          example: InGen Corporation
          type: string
        entityType:
          example: company
          type: string
        foundationDates:
          description: Foundation dates of the entity
          items:
            $ref: '#/components/schemas/SigmaidDateWithSource'
          nullable: true
          type: array
        hasIndirectOwners:
          type: boolean
        hasNetworkConnections:
          type: boolean
        indicatorSummaries:
          items:
            $ref: '#/components/schemas/SigmaidIndicatorSummary'
          nullable: true
          type: array
        locations:
          items:
            $ref: '#/components/schemas/SigmaidLocation'
          nullable: true
          type: array
        matchDOB:
          type: string
        matchLocation:
          type: string
        matchName:
          type: string
        matchStrength:
          type: number
        risk:
          $ref: '#/components/schemas/SigmaidRiskSummary'
        sigmaID:
          example: 3BX869NCJTZ5K
          type: string
        sources:
          items:
            $ref: '#/components/schemas/SigmaidSourcesByIntegration'
          nullable: true
          type: array
      type: object
    SigmaidEconomicActivity:
      properties:
        code:
          type: string
        label:
          type: string
        sourceAttribution:
          description: Not human readable. This can be used to look up against source information objects.
          items:
            example: abcd1234//1234567890
            type: string
          nullable: true
          type: array
      type: object
    SigmaidNetworkRiskProperties:
      properties:
        relationships:
          items:
            type: string
          nullable: true
          type: array
      type: object
    SigmaidNetworkRiskResult:
      properties:
        edges:
          description: The relationships between the entities in the network. Each relationship connects two entities in the Nodes list.
          items:
            $ref: '#/components/schemas/SigmaidEdge'
          nullable: true
          type: array
        nodes:
          description: The individual entities that are part of the network of the requested entity.
          items:
            $ref: '#/components/schemas/SigmaidNode'
          nullable: true
          type: array
        properties:
          $ref: '#/components/schemas/SigmaidNetworkRiskProperties'
      type: object
    SigmaidFacetVessel:
      properties:
        imo:
          $ref: '#/components/schemas/SigmaidTextWithSource'
        maritimeCallSigns:
          items:
            $ref: '#/components/schemas/SigmaidTextWithSource'
          nullable: true
          type: array
        portsOfRegistry:
          items:
            $ref: '#/components/schemas/SigmaidTextWithSource'
          nullable: true
          type: array
        types:
          items:
            $ref: '#/components/schemas/SigmaidTextWithSource'
          nullable: true
          type: array
      type: object
    SigmaidKYCEntityData:
      properties:
        aliases:
          items:
            $ref: '#/components/schemas/SigmaidTextWithSource'
          nullable: true
          type: array
        facts:
          items:
            $ref: '#/components/schemas/SigmaidFact'
          nullable: true
          type: array
        locations:
          items:
            $ref: '#/components/schemas/SigmaidLocation'
          nullable: true
          type: array
        telephones:
          items:
            $ref: '#/components/schemas/SigmaidTextWithSource'
          nullable: true
          type: array
        websites:
          items:
            $ref: '#/components/schemas/SigmaidTextWithSource'
          nullable: true
          type: array
      type: object
    SigmaidRiskSummary:
      properties:
        score:
          type: number
      type: object
    SigmaidEdge:
      properties:
        edgeID:
          description: A unique identifier for this edge.
          type: string
        extendedRelationshipData:
          $ref: '#/components/schemas/SigmaidExtendedRelationshipData'
        fromNode:
          description: The SigmaID of the node that this edge starts from.
          type: string
        inverseRelationship:
          description: The normalized relationship in the inverse direction.
          example: Is Subsidiary Of
          type: string
        relationship:
          description: The normalized relationship, as determined by SigmaID's NLP models.
          example: Has Subsidiary
          type: string
        relationshipDenotesOwnership:
          description: Whether this relationship imparts ownership or control. For example, 'Has Subsidiary' would have this field set to true, while 'Is Officer Of'' would have it set to false.
          type: boolean
        toNode:
          description: The SigmaID of the node that this edge points to.
          type: string
        unnormalizedRelationship:
          description: The raw text of the relationship as it appears in the source data.
          type: string
      type: object
    SigmaidLocation:
      properties:
        address:
          example: 10 Downing St, London SW1A 2AB, United Kingdom
          type: string
        country:
          example: United Kingdom
          type: string
        countryCode:
          example: GB
          type: string
        fromDate:
          example: '1684-05-20'
          type: string
        locality:
          example: London
          type: string
        majorAdministrativeDivision:
          example: England
          type: string
        minorAdministrativeDivision:
          example: City of Westminster
          type: string
        postalCode:
          example: SW1A 2AB
          type: string
        sourceAttribution:
          description: Not human readable. This can be used to look up against source information objects.
          items:
            example: abcd1234//1234567890
            type: string
          nullable: true
          type: array
        streetName:
          example: Downing St
          type: string
        streetNumber:
          example: '10'
          type: string
        toDate:
          example: '2020-05-20'
          type: string
        type:
          example: Residence
          type: string
      type: object
    SigmaidIdentification:
      properties:
        country:
          nullable: true
          type: string
        extras:
          additionalProperties:
            type: string
          nullable: true
          type: object
        label:
          type: string
        sourceAttribution:
          description: Not human readable. This can be used to look up against source information objects.
          items:
            example: abcd1234//1234567890
            type: string
          nullable: true
          type: array
        value:
          type: string
      type: object
    SigmaidExtractedRisk:
      properties:
        category:
          type: string
        highlights:
          description: Offsets of where the entity appears in the article body or title
          items:
            $ref: '#/components/schemas/SigmaidHighLightSection'
          type: array
      type: object
    SigmaidFact:
      properties:
        label:
          example: Notes
          type: string
        sourceAttribution:
          description: Not human readable. This can be used to look up against source information objects.
          items:
            example: abcd1234//1234567890
            type: string
          nullable: true
          type: array
        value:
          example: <text>
          type: string
      type: object
    SigmaidCorporateNumber:
      properties:
        country:
          items:
            type: string
          nullable: true
          type: array
        number:
          type: string
        register:
          items:
            type: string
          nullable: true
          type: array
        sourceAttribution:
          description: Not human readable. This can be used to look up against source information objects.
          items:
            example: abcd1234//1234567890
            type: string
          nullable: true
          type: array
      type: object
    SigmaidFacetPerson:
      properties:
        dobs:
          items:
            $ref: '#/components/schemas/SigmaidDateWithSource'
          nullable: true
          type: array
        genders:
          items:
            $ref: '#/components/schemas/SigmaidTextWithSource'
          nullable: true
          type: array
        identifications:
          items:
            $ref: '#/components/schemas/SigmaidIdentification'
          nullable: true
          type: array
        nationalities:
          items:
            $ref: '#/components/schemas/SigmaidTextWithSource'
          nullable: true
          type: array
        politicalPositions:
          items:
            $ref: '#/components/schemas/SigmaidPoliticalPosition'
          nullable: true
          type: array
      type: object
    SigmaidFacetAircraft:
      properties:
        manufactureDates:
          items:
            $ref: '#/components/schemas/SigmaidDateWithSource'
          nullable: true
          type: array
        models:
          items:
            $ref: '#/components/schemas/SigmaidTextWithSource'
          nullable: true
          type: array
        operators:
          items:
            $ref: '#/components/schemas/SigmaidTextWithSource'
          nullable: true
          type: array
        otherIdentifiers:
          items:
            $ref: '#/components/schemas/SigmaidIdentification'
          nullable: true
          type: array
        serialNumbers:
          items:
            $ref: '#/components/schemas/SigmaidTextWithSource'
          nullable: true
          type: array
        tailNumbers:
          items:
            $ref: '#/components/schemas/SigmaidTextWithSource'
          nullable: true
          type: array
      type: object
    ResponseFullSearchResultWithAlertPubliclyDocumented:
      properties:
        alertCreatedURN:
          description: Populated if the search resulted in an alert being created. Contains the URN of the alert. Only valid if using createAlerts=true in the request.
          type: string
        resultCount:
          description: Number of individual matches found
          example: 2
          type: integer
        resultRows:
          items:
            $ref: '#/components/schemas/SigmaidCompositeResult'
          nullable: true
          type: array
        searchDate:
          example: '2023-01-01T00:00:00Z'
          format: date-time
          type: string
      required:
      - resultCount
      - resultRows
      - searchDate
      type: object
    SigmaidIndicatorSummary:
      properties:
        category:
          example: Sanctions
          type: string
        count:
          example: 2
          type: integer
        isNetwork:
          description: Indicates whether the indicator is describes this entity or one of its network connections
          example: false
          type: boolean
        maxScore:
          example: 100
          type: integer
      type: object
    SigmaidEventArticle:
      properties:
        articleHash:
          type: string
        body:
          description: The full-text article body, if available
          type: string
        extractedEntities:
          description: Detected entities and highlights from the article body/title. This can be natural persons or entities.
          items:
            $ref: '#/components/schemas/SigmaidExtractEntity'
          nullable: true
          type: array
        extractedRisks:
          description: Highlight information for risky keywords or phrases in the article or title.
          items:
            $ref: '#/components/schemas/SigmaidExtractedRisk'
          type: array
        extractedTerritories:
          description: Countries and major administrative divisions (e.g., states, provinces) mentioned in the article.
          items:
            $ref: '#/components/schemas/SigmaidExtractedTerritory'
          nullable: true
          type: array
        humanVerified:
          description: A small portion of articles have been manually verified by Sigma360 analysts, this field indicates whether the article has been verified adverse or not
          type: boolean
        isPreferredPublisher:
          description: High-quality government gazettes, newspapers of record, or reputable news agencies are listed as preferred publishers. This field indicates whether the article is from a preferred publisher
          type: boolean
        language:
          description: The ISO 639-1 two-letter language code of the article
          type: string
        materialityScore:
          description: A ranking of how severe the event is, based on the article text. This is a number between 0 and 1, where 1 is the most severe.
          type: number
        publishedDate:
          description: The date and time the article was published, in ISO 8601 format
          format: date-time
          type: string
        publisher:
          description: A human-readable name of the publisher
          example: New York Times
          type: string
        publisherCountryCode:
          description: The ISO 3166-1 alpha-2 country code of the publisher's country. This is not the country of the event or journalist, but the country of the publisher's headquarters
          type: string
        title:
          description: The article title
          type: string
        topics:
          description: A list of detected event topics, such as 'white_collar_crime'
          items:
            type: string
          nullable: true
          type: array
        url:
          description: The article URL
          type: string
      type: object
    SigmaidExtractedTerritory:
      properties:
        adminOne:
          description: The first-level administrative division of the territory, if applicable. For example, a state in the US or a province in Canada.
          nullable: true
          type: string
        count:
          description: The amount of times this territory was mentioned in the article
          type: integer
        country:
          description: The ISO 3166-1 alpha-2 country code of the territory
          type: string
        evidence:
          description: The snippets of the article that support a territory determination
          items:
            type: string
          nullable: true
          type: array
        highlights:
          description: Offsets of where the entity appears in the article body or title
          items:
            $ref: '#/components/schemas/SigmaidHighLightSection'
          type: array
      type: object
    SigmaidDateWithSource:
      properties:
        humanReadable:
          description: A human-readable representation of the range. Show in user interfaces instead of the date range if present
          example: Circa 1980
          nullable: true
          type: string
        sourceAttribution:
          description: Not human readable. This can be used to look up against source information objects.
          items:
            example: abcd1234//1234567890
            type: string
          nullable: true
          type: array
        until:
          description: If the date is a range, the end of the range
          example: '2023-01-01T00:00:00Z'
          format: date-time
          nullable: true
          type: string
        value:
          description: The date, or the start of a date range
          example: '2023-01-01T00:00:00Z'
          format: date-time
          type: string
      type: object
    SigmaidEntityResult:
      properties:
        KYC:
          $ref: '#/components/schemas/SigmaidKYCEntityData'
        entityName:
          $ref: '#/components/schemas/SigmaidTextWithSource'
        facet:
          $ref: '#/components/schemas/SigmaidFullEntityFacet'
        indicatorSummaries:
          items:
            $ref: '#/components/schemas/SigmaidIndicatorSummary'
          type: array
        indicators:
          items:
            $ref: '#/components/schemas/SigmaidIndicator'
          nullable: true
          type: array
        news:
          items:
            $ref: '#/components/schemas/SigmaidNewsEvent'
          nullable: true
          type: array
        riskSummary:
          $ref: '#/components/schemas/SigmaidRiskSummary'
        sigmaID:
          type: string
      required:
      - sigmaID
      - riskSummary
      - indicatorSummaries
      - entityName
      - KYC
      - news
      - indicators
      - facet
      type: object
    SigmaidSourceURL:
      properties:
        name:
          type: string
        url:
          nullable: true
          type: string
      type: object
    SigmaidTextWithSource:
      properties:
        sourceAttribution:
          description: Not human readable. This can be used to look up against source information objects.
          items:
            example: abcd1234//1234567890
            type: string
          nullable: true
          type: array
        value:
          example: <text>
          type: string
      type: object
    SigmaidExtendedRelationshipData:
      properties:
        asOfDate:
          description: The date this relationship data was reported as of.
          type: string
        currency:
          description: The currency of the monetary value.
          type: string
        endDate:
          description: The date this relationship ended.
          type: string
        former:
          description: Whether this relationship is no longer active.
          type: boolean
        monetaryValue:
          description: The monetary value associated with this relationship.
          type: string
        numShares:
          description: The number of shares held in this relationship.
          type: string
        percent:
          description: The ownership or control percentage associated with this relationship.
          type: string
        startDate:
          description: The date this relationship began.
          type: string
        ultimateSources:
          description: The original data sources for this relationship.
          items:
            type: string
          nullable: true
          type: array
      type: object
    RequestFullSingleScreeningRequestPublic:
      properties:
        aliases:
          description: Secondary names to perform a search on
          items:
            example: InGen, InGen Corp
            type: string
          nullable: true
          type: array
        countries:
          description: ISO 3166-1 alpha-2
          items:
            example: US
            type: string
          nullable: true
          type: array
        createAlerts:
          default: false
          description: Optional. If true, alerts will be generated for this query if the results contain risk. Alerts are available in the UI or through webhook notifications.
          nullable: true
          type: boolean
        customFields:
          description: Optional. A list of custom fields to be associated with the entity for cross-referencing or disambiguation in alerts and monitoring. Does not affecting risk or matching logic. Each field must have a unique key.
          items:
            $ref: '#/components/schemas/SigmaidCustomEntityField'
          nullable: true
          type: array
        customerKey:
          description: Optional. A user-provided identifier that will be returned in alerts and monitoring. Any format.
          example: ABC1234567890
          type: string
        dob:
          description: Birth or foundation date. YYYY, YYYY-MM, YYYY-MM-DD, YYYY/MM or YYYY/MM/DD format.
          example: '1993-06-11'
          nullable: true
          type: string
        entityName:
          description: The primary name of the search
          example: InGen Corporation
          type: string
        entityType:
          enum:
          - person
          - company
          - aircraft
          - vessel
          example: company
          nullable: true
          type: string
        filterSetID:
          description: The Filter Set to use for this search. You may create and view your filtersets in the UI, under Settings > Filter Sets..
          minimum: 0
          type: integer
      required:
      - entityName
      - filterSetID
      type: object
    SigmaidIndicator:
      properties:
        category:
          example: Sanctions
          type: string
        causalSigmaID:
          $ref: '#/components/schemas/SigmaidSummarySearchResultRow'
        code:
          example: SAN006
          type: string
        date:
          example: '2023-01-01T00:00:00Z'
          format: date-time
          nullable: true
          type: string
        description:
          example: Swiss State Secretariat for Economic Affairs
          type: string
        extras:
          additionalProperties:
            items:
              type: string
            type: array
          description: Extra details about the indicator
          nullable: true
          type: object
        hopsAway:
          example: 0
          type: integer
        name:
          example: Appears on sanction list
          type: string
        originatingSigmaID:
          type: string
        primaryExtras:
          additionalProperties:
            items:
              type: string
            type: array
          description: Extra details about the indicator, typical shown above the fold
          nullable: true
          type: object
        relationshipChain:
          $ref: '#/components/schemas/SigmaidRelationshipChain'
        score:
          example: 90
          type: integer
        sourceAttribution:
          description: Not human readable. This can be used to look up against source information objects.
          items:
            example: abcd1234//1234567890
            type: string
          nullable: true
          type: array
        sources:
          items:
            $ref: '#/components/schemas/SigmaidSourceURL'
          nullable: true
          type: array
        subcategory:
          example: sanctions_swiss
          type: string
        urn:
          example: urn:sigma:indicator:5VpYSbsw2R6UaVxFilHv_TpJ5wJZocEzMAaLvFkVJAg=
          type: string
      required:
      - urn
      - code
      - name
      - category
      - subcategory
      - hopsAway
      - sources
      - description
      type: object
    SigmaidBasicEntityResult:
      properties:
        entityName:
          example: InGen Corporation
          type: string
        entityType:
          example: company
          type: string
        sigmaID:
          example: 3BX869NCJTZ5K
          type: string
      type: object
    SigmaidNewsEvent:
      properties:
        articles:
          items:
            $ref: '#/components/schemas/SigmaidEventArticle'
          nullable: true
          type: array
        entityRisk:
          type: string
        eventConfidence:
          type: number
        eventLabel:
          type: string
        eventMaterialityScore:
          type: number
        eventSeverity:
          type: string
        humanVerified:
          type: boolean
        id:
          type: string
        isPreferredPublisher:
          type: boolean
        sigmaID:
          type: string
        topics:
          items:
            type: string
          nullable: true
          type: array
        unformattedLabel:
          type: string
      type: object
  securitySchemes:
    apiKey:
      description: API Key
      in: header
      name: Authorization
      type: apiKey
externalDocs:
  description: Sigma360 Product Information
  url: https://sigma360.com