Silverflow Screenings API

openapi: 3.2.0
info:
  title: Silverflow Screenings API
  version: 1.417.0
  contact:
    name: API Support
    email: support@silverflow.com
  license:
    name: Commercial
  description: 'Operations tagged Screenings across 2 of this provider''s published API definitions: silverflow-openapi.yml, silverflow-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://eu-west-1.api.silverflow.com/v1
  description: Production URL for Europe - Equivalent to https://api.silverflow.co/v1
- url: https://us-east-2.api.silverflow.com/v1
  description: Production URL for North America
- url: https://eu-west-1.api-sbx.silverflow.com/v1
  description: Sandbox URL - Equivalent to https://api-sbx.silverflow.co/v1
security:
- ApiKey: []
- BearerToken: []
tags:
- name: Screenings
  description: ' '
paths:
  /screenings:
    post:
      operationId: postScreening
      summary: Create Screening Request [EXPERIMENTAL]
      description: 'Submit merchant information to initiate a merchant screening request.

        This will trigger a Mastercard MATCH_PRO or a Visa VMSS screening submission.

        Processing is asynchronous. Results are generally available in under two minutes, but may be delayed depending on the type of screening and the load on the card scheme screening services.

        <br> **Note**: The website URL and address are retrieved from the Merchant entity.

        - "https://", "www", and excess subdomains might be trimmed while preserving key URL components for VMSS screening requests to ensure it does not exceed 84 characters.

        - city will be trimmed to ensure it does not exceed 20 characters for MATCH_PRO or 30 characters for VMSS.

        - address lines from the merchant will be trimmed to ensure it does not exceed 60 characters for MATCH.

        - duplicate principals with the same firstName and lastName (case-insensitive) will be deduplicated for VMSS screening requests, keeping only the first occurrence.

        '
      tags:
      - Screenings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScreeningRequest'
            examples:
              MATCH_PRO:
                $ref: '#/components/examples/screening-submit-request-mc-pro'
              VMSS:
                $ref: '#/components/examples/screening-submit-request-visa'
      responses:
        '201':
          description: Information on the submitted screening request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Screening'
              examples:
                MATCH_PRO:
                  $ref: '#/components/examples/screening-submit-response-mc-pro'
                VMSS:
                  $ref: '#/components/examples/screening-submit-response-visa'
        '400':
          $ref: '#/components/responses/InvalidInputError'
        '401':
          $ref: '#/components/responses/responses-UnauthorizedError'
        '403':
          $ref: '#/components/responses/responses-ForbiddenError'
        '404':
          $ref: '#/components/responses/responses-NotFoundError'
        '429':
          $ref: '#/components/responses/responses-TooManyRequestsError'
    get:
      operationId: listScreenings
      summary: List Screenings [EXPERIMENTAL]
      description: 'List screening entities created by an agent.

        '
      tags:
      - Screenings
      parameters:
      - $ref: '#/components/parameters/sortOrder'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offsetToken'
      - $ref: '#/components/parameters/from'
      - $ref: '#/components/parameters/to'
      responses:
        '200':
          description: Page of screenings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScreeningsPage'
              examples:
                submit:
                  $ref: '#/components/examples/list-screenings-response'
        '400':
          $ref: '#/components/responses/InvalidInputError'
        '401':
          $ref: '#/components/responses/responses-UnauthorizedError'
        '403':
          $ref: '#/components/responses/responses-ForbiddenError'
        '404':
          $ref: '#/components/responses/responses-NotFoundError'
        '429':
          $ref: '#/components/responses/responses-TooManyRequestsError'
    servers:
    - url: https://eu-west-1.api.silverflow.com/v1
      description: Production URL for Europe - Equivalent to https://api.silverflow.co/v1
    - url: https://us-east-2.api.silverflow.com/v1
      description: Production URL for North America
    - url: https://eu-west-1.api-sbx.silverflow.com/v1
      description: Sandbox URL - Equivalent to https://api-sbx.silverflow.co/v1
  /screenings/{screeningsKey}:
    get:
      operationId: getScreening
      summary: Get a Screening [EXPERIMENTAL]
      description: 'Retrieve a screening entity.

        '
      tags:
      - Screenings
      parameters:
      - $ref: '#/components/parameters/screeningKey'
      responses:
        '200':
          description: Information on the requested screening.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Screening'
              examples:
                MATCH:
                  $ref: '#/components/examples/get-screening-response-mc'
                VMSS:
                  $ref: '#/components/examples/get-screening-response-visa'
                MATCH_PRO:
                  $ref: '#/components/examples/get-screening-response-mc-pro'
        '400':
          $ref: '#/components/responses/InvalidInputError'
        '401':
          $ref: '#/components/responses/responses-UnauthorizedError'
        '403':
          $ref: '#/components/responses/responses-ForbiddenError'
        '404':
          $ref: '#/components/responses/responses-NotFoundError'
        '429':
          $ref: '#/components/responses/responses-TooManyRequestsError'
    servers:
    - url: https://eu-west-1.api.silverflow.com/v1
      description: Production URL for Europe - Equivalent to https://api.silverflow.co/v1
    - url: https://us-east-2.api.silverflow.com/v1
      description: Production URL for North America
    - url: https://eu-west-1.api-sbx.silverflow.com/v1
      description: Sandbox URL - Equivalent to https://api-sbx.silverflow.co/v1
  /screenings/{screeningsKey}/results:
    get:
      operationId: listScreeningResults
      summary: List Screening Results [EXPERIMENTAL]
      description: 'Retrieves the results of a screening request.

        '
      tags:
      - Screenings
      parameters:
      - $ref: '#/components/parameters/screeningKey'
      - $ref: '#/components/parameters/sortOrder'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offsetToken'
      responses:
        '200':
          description: List of screening results.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScreeningResultsPage'
              examples:
                noMatch:
                  $ref: '#/components/examples/list-screenings-no-match-response'
                partialMatch:
                  $ref: '#/components/examples/list-screenings-partial-match-response'
        '400':
          $ref: '#/components/responses/InvalidInputError'
        '401':
          $ref: '#/components/responses/responses-UnauthorizedError'
        '403':
          $ref: '#/components/responses/responses-ForbiddenError'
        '404':
          $ref: '#/components/responses/responses-NotFoundError'
        '409':
          $ref: '#/components/responses/responses-ConflictError'
        '429':
          $ref: '#/components/responses/responses-TooManyRequestsError'
    servers:
    - url: https://eu-west-1.api.silverflow.com/v1
      description: Production URL for Europe - Equivalent to https://api.silverflow.co/v1
    - url: https://us-east-2.api.silverflow.com/v1
      description: Production URL for North America
    - url: https://eu-west-1.api-sbx.silverflow.com/v1
      description: Sandbox URL - Equivalent to https://api-sbx.silverflow.co/v1
components:
  examples:
    screening-submit-request-visa:
      summary: Create a screening request for VMSS
      value:
        screeningType: VMSS
        doingBusinessAsName: ACME Corp. A/S
        binKey: bin-123412414
        merchantKey: mct-123412414
        tradeOverInternet: false
        businessPhoneNumbers:
        - '31201234567'
        - '31201234568'
        principals:
        - lastName: Doe
          firstName: Jane
        businessCategory: marketplace
    get-screening-response-visa:
      summary: Get a VMSS screening response
      value:
        key: scr-2VfOLO8cmTcIe0PkDgKl
        agentKey: cgt-2VfOLO8cmTcIe0PkDgKl
        binKey: bin-2VfOLO8cmTcIe0PkDgKl
        merchantKey: mct-2VfOLO8cmTcIe0PkDgKl
        status: active
        screeningStatus: pending
        screeningType: VMSS
        created: '2021-12-02T13:00:18.487Z'
        version: 1
        screeningDetail:
          bid: '10056588'
          doingBusinessAsName: ACME Corp. A/S
          tradeOverInternet: false
          businessPhoneNumbers:
          - '31201234567'
          - '31201234568'
          businessCategory: marketplace
          principals:
          - lastName: Doe
            firstName: Jane
          websiteUrl: https://www.acme.com
          address:
            countryCode:
              alpha2: NL
              alpha3: NLD
              numeric: '528'
            stateOrProvince: Westeros
            city: Braavos
            line1: Kings Road
            line2: '1'
            postalCode: 1103JT
    get-screening-response-mc:
      summary: Get a MATCH screening response
      value:
        key: scr-2VfOLO8cmTcIe0PkDgKl
        agentKey: cgt-2VfOLO8cmTcIe0PkDgKl
        binKey: bin-2VfOLO8cmTcIe0PkDgKl
        merchantKey: mct-2VfOLO8cmTcIe0PkDgKl
        status: active
        screeningStatus: pending
        screeningType: MATCH
        created: '2021-12-02T13:00:18.487Z'
        version: 1
        totalNumberOfResults: 0
        screeningDetail:
          doingBusinessAsName: ACME Corp. A/S
          acquirerIdCode: '123213'
          legalName: ACME Corp. A/S
          principals:
          - lastName: Doe
            firstName: Jane
            phoneNumber: '31201234567'
            address:
              countryCode:
                alpha2: NL
                alpha3: NLD
                numeric: '528'
              stateOrProvince: Westeros
              city: Braavos
              line1: Kings Road
              line2: '1'
              postalCode: 1103JT
          websiteUrl: https://www.acme.com
          address:
            countryCode:
              alpha2: NL
              alpha3: NLD
              numeric: '528'
            stateOrProvince: Westeros
            city: Braavos
            line1: Kings Road
            line2: '1'
            postalCode: 1103JT
    list-screenings-no-match-response:
      summary: Result no match
      value:
        moreItems: false
        screeningResults: []
    list-screenings-response:
      summary: List screenings response
      value:
        offsetToken: 23fOLO8cmTcIe0PkDgKl23fOLO8cmTcIe0PkDgKl
        moreItems: true
        screenings:
        - key: scr-23fOLO8cmTcIe0PkDgKl
          agentKey: cgt-2VfOLO8cmTcIe0PkDgKl
          binKey: bin-2VfOLO8cmTcIe0PkDgKl
          merchantKey: mct-2456O7O8cmTcIe0PkDgKl
          status: active
          screeningStatus: pending
          screeningType: VMSS
          created: '2021-12-02T13:00:18.487Z'
          version: 1
          screeningDetail:
            bid: '10056588'
            doingBusinessAsName: ACME Corp. A/S
            tradeOverInternet: false
            businessPhoneNumbers:
            - '31201234567'
            - '31201234568'
            businessCategory: marketplace
            principals:
            - lastName: Doe
              firstName: Jane
            websiteUrl: https://www.acme.com
            address:
              countryCode:
                alpha2: NL
                alpha3: NLD
                numeric: '528'
              stateOrProvince: Westeros
              city: Braavos
              line1: Kings Road
              line2: '1'
              postalCode: 1103JT
        - key: scr-2VfOLO8cmTcIe0PkDgKl
          agentKey: cgt-2VfOLO8cmTcIe0PkDgKl
          binKey: bin-2VfOLO8cmTcIe0PkDgKl
          merchantKey: mct-2VfOLO8cmTcIe0PkDgKl
          status: active
          screeningStatus: pending
          screeningType: MATCH
          created: '2021-12-02T13:00:18.487Z'
          version: 1
          screeningDetail:
            doingBusinessAsName: ACME Corp. A/S
            acquirerIdCode: '123213'
            legalName: ACME Corp. A/S
            principals:
            - lastName: Doe
              firstName: Jane
              phoneNumber: '31201234567'
              address:
                countryCode:
                  alpha2: NL
                  alpha3: NLD
                  numeric: '528'
                stateOrProvince: Westeros
                city: Braavos
                line1: Kings Road
                line2: '1'
                postalCode: 1103JT
            websiteUrl: https://www.acme.com
            address:
              countryCode:
                alpha2: NL
                alpha3: NLD
                numeric: '528'
              stateOrProvince: Westeros
              city: Braavos
              line1: Kings Road
              line2: '1'
              postalCode: 1103JT
    screening-submit-request-mc-pro:
      summary: Create a screening request for MATCH_PRO
      value:
        screeningType: MATCH_PRO
        doingBusinessAsName: ACME Corp. A/S
        binKey: bin-123412414
        merchantKey: mct-123412414
        merchantPhoneNumber: '31641444444'
        merchantCategoryCode: '1234'
        principals:
        - lastName: Doe
          firstName: Jane
          phoneNumber: '31201234567'
          email: jane@doe.com
          address:
            countryCode:
              alpha2: NL
            stateOrProvince: Westeros
            city: Braavos
            line1: Kings Road
            line2: '1'
            postalCode: 1103JT
    list-screenings-partial-match-response:
      summary: Result with 2 partial match
      value:
        moreItems: false
        screeningResults:
        - terminationReason: common-point-of-purchase
          terminatedMerchant:
            acquirerIdCode: '123213'
            legalName:
              matchType: none
              value: ACME Corp. A/S
            doingBusinessAsName:
              matchType: none
              value: ACME Corp. A/S
            address:
              countryCode:
                value: NLD
                matchType: partial
              stateOrProvince:
                value: Westeros
                matchType: partial
              city:
                value: Braavos
                matchType: partial
              line1:
                value: Kings Road
                matchType: partial
              postalCode:
                value: 1103JT
                matchType: partial
            websiteUrl:
              matchType: phonetic
              value:
              - https://www.aqme.com
            principals:
            - firstName:
                value: Jane
                matchType: none
              lastName:
                value: Doe
                matchType: partial
              address:
                countryCode:
                  value: NLD
                  matchType: partial
                stateOrProvince:
                  matchType: partial
                  value: Westeros
                city:
                  matchType: partial
                  value: Braavos
                line1:
                  matchType: partial
                  value: Kings Road
                postalCode:
                  matchType: partial
                  value: 1103JT
              phoneNumber:
                value: '31201234567'
                matchType: partial
        - terminationReason: excessive-chargebacks
          terminatedMerchant:
            acquirerIdCode: '2325'
            doingBusinessAsName:
              matchType: partial
              value: ACME Corp. A/S
            legalName:
              matchType: none
              value: ACME Corp. A/S
            address:
              countryCode:
                value: NLD
                matchType: partial
              stateOrProvince:
                matchType: partial
                value: Westeros
              city:
                matchType: partial
                value: Braavos
              line1:
                matchType: partial
                value: Kings Road
              postalCode:
                matchType: partial
                value: 1103JT
            websiteUrl:
              matchType: phonetic
              value:
              - https://www.aqme.com
            principals:
            - firstName:
                value: Jane
                matchType: none
              lastName:
                value: Doe
                matchType: partial
              address:
                countryCode:
                  value: NLD
                  matchType: partial
                stateOrProvince:
                  matchType: partial
                  value: Westeros
                city:
                  matchType: partial
                  value: Braavos
                line1:
                  matchType: partial
                  value: Kings Road
                postalCode:
                  matchType: partial
                  value: 1103JT
              phoneNumber:
                value: '31201234567'
                matchType: partial
    screening-submit-response-visa:
      summary: Create a screening response VMSS
      value:
        key: scr-2VfOLO8cmTcIe0PkDgKl
        created: '2021-12-02T13:00:18.487Z'
        version: 1
        agentKey: cgt-2VfOLO8cmTcIe0PkDgKl
        binKey: bin-2VfOLO8cmTcIe0PkDgKl
        merchantKey: mct-2VfOLO8cmTcIe0PkDgKl
        status: active
        screeningStatus: pending
        screeningType: VMSS
        screeningDetail:
          bid: '10056588'
          doingBusinessAsName: ACME Corp. A/S
          tradeOverInternet: false
          businessPhoneNumbers:
          - '31201234567'
          - '31201234568'
          businessCategory: marketplace
          principals:
          - lastName: Doe
            firstName: Jane
          websiteUrl: https://www.acme.com
          address:
            countryCode:
              alpha2: NL
              alpha3: NLD
              numeric: '528'
            stateOrProvince: Westeros
            city: Braavos
            line1: Kings Road
            line2: '1'
            postalCode: 1103JT
    get-screening-response-mc-pro:
      summary: Get a MATCH_PRO screening response
      value:
        key: scr-2VfOLO8cmTcIe0PkDgKl
        agentKey: cgt-2VfOLO8cmTcIe0PkDgKl
        binKey: bin-2VfOLO8cmTcIe0PkDgKl
        merchantKey: mct-2VfOLO8cmTcIe0PkDgKl
        status: active
        screeningStatus: pending
        screeningType: MATCH_PRO
        created: '2021-12-02T13:00:18.487Z'
        version: 1
        totalNumberOfResults: 0
        screeningDetail:
          doingBusinessAsName: ACME Corp. A/S
          acquirerIdCode: '123213'
          legalName: ACME Corp. A/S
          merchantCategoryCode: '5999'
          merchantPhoneNumber: '31850609160'
          principals:
          - lastName: Doe
            firstName: Jane
            phoneNumber: '31201234567'
            email: jane.doe@acme.com
            address:
              countryCode:
                alpha2: NL
                alpha3: NLD
                numeric: '528'
              stateOrProvince: Westeros
              city: Braavos
              line1: Kings Road
              line2: '1'
              postalCode: 1103JT
          websiteUrl: https://www.acme.com
          address:
            countryCode:
              alpha2: NL
              alpha3: NLD
              numeric: '528'
            stateOrProvince: Westeros
            city: Braavos
            line1: Kings Road
            line2: '1'
            postalCode: 1103JT
    screening-submit-response-mc-pro:
      summary: Create a screening response MATCH_PRO
      value:
        key: scr-2VfOLO8cmTcIe0PkDgKl
        created: '2021-12-02T13:00:18.487Z'
        version: 1
        agentKey: cgt-2VfOLO8cmTcIe0PkDgKl
        binKey: bin-2VfOLO8cmTcIe0PkDgKl
        merchantKey: mct-2VfOLO8cmTcIe0PkDgKl
        status: active
        screeningStatus: pending
        screeningType: MATCH_PRO
        screeningDetail:
          doingBusinessAsName: ACME Corp. A/S
          acquirerIdCode: '123213'
          legalName: ACME Corp. A/S
          merchantCategoryCode: '5999'
          merchantPhoneNumber: '31850609160'
          principals:
          - lastName: Doe
            firstName: Jane
            phoneNumber: '31201234567'
            email: jane.doe@acme.com
            address:
              countryCode:
                alpha2: NL
                alpha3: NLD
                numeric: '528'
              stateOrProvince: Westeros
              city: Braavos
              line1: Kings Road
              line2: '1'
              postalCode: 1103JT
          websiteUrl: https://www.acme.com
          address:
            countryCode:
              alpha2: NL
              alpha3: NLD
              numeric: '528'
            stateOrProvince: Westeros
            city: Braavos
            line1: Kings Road
            line2: '1'
            postalCode: 1103JT
  schemas:
    schemas-line2:
      allOf:
      - $ref: '#/components/schemas/ExtendedNameOfPeopleAndPlaces'
      - description: 'Address line 2. Clients not enrolled in the "extended character set beta" are still subject to the `^[\w ,\.\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u00FF-]+$` pattern for field input.

          '
    MatchProScreeningRequest:
      type: object
      required:
      - screeningType
      - merchantKey
      - binKey
      - doingBusinessAsName
      - principals
      - merchantCategoryCode
      - merchantPhoneNumber
      description: 'Post an array of principals with all details to be screened for the merchant acceptor.

        '
      properties:
        screeningType:
          type: string
          enum:
          - MATCH_PRO
        merchantKey:
          $ref: '#/components/schemas/merchantKey'
        binKey:
          $ref: '#/components/schemas/schemas-binKey'
        doingBusinessAsName:
          type: string
          description: Assumed, trade or fictitious name of the merchant.
          pattern: ^[\x20-\x7E\xA0-\xA3\xA5\xA7\xA9-\xB3\xB5-\xB7\xB9-\xBB\xBF-\xFF\u20AC\u0160\u0161\u017D\u017E\u0152\u0153\u0178]+$
          minLength: 1
          maxLength: 110
        merchantCategoryCode:
          type: string
          description: A classification code used in authorization, clearing and other transactions or reports to identify the type of merchant.
          pattern: ^\d{4}$
          minLength: 4
          maxLength: 4
        merchantPhoneNumber:
          $ref: '#/components/schemas/businessPhoneNumber'
          description: "The merchant's business phone number, including area code.\n  - For U.S. numbers\n    - Must be exactly 10 digits and cannot start with 0 or 1.\n  - For non-U.S. numbers\n    - Can be up to 25 digits. Do not include the country code. \n  - Formatting\n    - Digits only. Do not use symbols or formatting characters (e.g., parentheses, spaces, or dashes).\n"
        principals:
          type: array
          description: The principals of the business
          minItems: 1
          maxItems: 5
          items:
            $ref: '#/components/schemas/MatchProPrincipalInput'
    ScreeningDetail:
      oneOf:
      - $ref: '#/components/schemas/MatchScreeningDetail'
      - $ref: '#/components/schemas/MatchProScreeningDetail'
      - $ref: '#/components/schemas/VmssScreeningDetail'
    tradeOverInternet:
      type: boolean
      description: TradeOverInternet
    ScreeningRequest:
      oneOf:
      - $ref: '#/components/schemas/MatchProScreeningRequest'
      - $ref: '#/components/schemas/VmssScreeningRequest'
      discriminator:
        propertyName: screeningType
        mapping:
          MATCH_PRO: '#/components/schemas/MatchProScreeningRequest'
          VMSS: '#/components/schemas/VmssScreeningRequest'
    version:
      type: integer
      description: The version of this object
      format: int64
    CountryCodeAlpha2:
      type: object
      required:
      - alpha2
      additionalProperties: false
      properties:
        alpha2:
          $ref: '#/components/schemas/countryCodeAlpha2'
    visaPrincipalLastName:
      type: string
      pattern: ^[\w ,\.\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u00FF-]+$
      minLength: 1
      maxLength: 15
    status:
      type: string
      description: The status of the object
      enum:
      - active
      - archived
    businessPhoneNumber:
      type: string
      description: An international phone number. Within the USA, phone numbers have a length of 10, and for outside the US, it can be any length with a maximum of 12 digits. Within the U.S. phone numbers can not start with 0 or 1. If the number is outside the U.S. region; do not include the country code. The phone number must be digits only, with no format characters such as parenthesis or dashes.
      pattern: ^[0-9]{10,12}$
      minLength: 10
      maxLength: 12
      example: '31850609160'
    schemas-acquirerIdCode:
      type: string
      description: Acquirer Institution ID code. For Mastercard, this field corresponds to the Acquirer ICA. For Visa, this field corresponds to the CIB, which usually has the same value as the BIN.
      pattern: ^\d+$
      minLength: 6
      maxLength: 6
    ValidationError:
      type: object
      required:
      - path
      - message
      properties:
        path:
          type: string
          description: A relative path to the error location within the request body.
        errorCode:
          type: string
          description: A code that identifies the error.
        message:
          type: string
          description: A brief description of the validation error.
    ExtendedNameOfPeopleAndPlaces:
      type: string
      pattern: ^[\x20-\x7E\xA0-\xA3\xA5\xA7\xA9-\xB3\xB5-\xB7\xB9-\xBB\xBF-\xFF\u20AC\u0160\u0161\u017D\u017E\u0152\u0153\u0178]+$
      minLength: 1
      maxLength: 120
    ScreeningsPage:
      allOf:
      - $ref: '#/components/schemas/Page'
      - type: object
        required:
        - screenings
        properties:
          screenings:
            type: array
            items:
              $ref: '#/components/schemas/Screening'
    RecordMatchStringArray:
      type: object
      description: 'Describes the type of match and the value of the record that matched with the input.

        Some sensitive fields will be masked by the card networks.

        '
      required:
      - matchType
      - value
      properties:
        matchType:
          $ref: '#/components/schemas/matchType'
        value:
          type: array
          minItems: 0
          maxItems: 5
          items:
            type: string
    terminatedMerchant:
      oneOf:
      - $ref: '#/components/schemas/VmssScreeningResult'
      - anyOf:
        - $ref: '#/components/schemas/MatchScreeningResult'
        - $ref: '#/components/schemas/MatchProScreeningResult'
    CountryCode:
      type: object
      required:
      - alpha3
      - alpha2
      - numeric
      properties:
        alpha3:
          $ref: '#/components/schemas/countryCodeAlpha3'
        alpha2:
          $ref: '#/components/schemas/countryCodeAlpha2'
        numeric:
          $ref: '#/components/schemas/countryCodeNumeric'
    RecordMatchString:
      type: object
      description: 'Describes the type of match and the value of the record that matched with the input.

        Some sensitive fields will be masked by the card networks

        '
      required:
      - matchType
      properties:
        matchType:
          $ref: '#/components/schemas/matchType'
        value:
          type: string
    schemas-city:
      allOf:
      - $ref: '#/components/schemas/ExtendedNameOfPeopleAndPlaces'
      - description: 'The city of the address. Clients not enrolled in the "extended character set beta" are still subject to the `^[\w ,\.\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u00FF-]+$` pattern for field input.

          '
    MatchProPrincipal:
      type: object
      required:
      - firstName
      - lastName
      - phoneNumber
      - address
      - email
      description: 'A principal of the business. Could be a director, founder, C-level executive, et cetera.

        '
      properties:
        firstName:
          allOf:
          - description: First name of the principal legal owner of the merchant
          - $ref: '#/components/schemas/NameOfPeopleAndPlaces'
        lastName:
          allOf:
          - description: Last name of the principal legal owner of the merchant
          - $ref: '#/components/schemas/NameOfPeopleAndPlaces'
        phoneNumber:
          $ref: '#/components/schemas/businessPhoneNumber'
          description: The Business or Merchant's phone number, including the area code. Within the USA, phone numbers have a length of 10, and for outside the US, it can be any length with a maximum of 12 digits. Within the U.S. phone numbers can not start with 0 or 1. If the number is outside the U.S. region; do not include the country code. The phone number must be digits only, with no format characters such as parenthesis or dashes.
        address:
          $ref: '#/components/schemas/schemas-Address'
        email:
          $ref: '#/components/schemas/MatchProEmail'
    screeningKey:
      description: Uniquely identifies a screening
      type: string
      pattern: ^scr-[a-zA-Z0-9]+$
      minLength: 5
      maxLength: 120
    vmssDoingBusinessAsName:
      type: string
      description: Assumed, trade or fictitious name of the merchant. The name will be trimmed if greater than 70.
      pattern: ^[\w\s\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u00FF,\-()'`.\/;:&$#!+?@=\\]*$
    VmssScreeningResult:
      type: object
      required:
      - bid
      - doingBusinessAsName
      - businessPhoneNumbers
      - address
      - principals
      - websiteUrl
      properties:
        bid:
          $ref: '#/components/schemas/bid'
        doingBusinessAsName:
          $ref: '#/components/schemas/RecordMatchString'
        businessPhoneNumbers:
          $ref: '#/components/schemas/RecordMatchStringArray'
        websiteUrl:
          $ref: '#/components/schemas/RecordMatchStringArray'
        address:
          $ref: '#/components/schemas/AddressMatch'
        principals:
          type: array
          items:
            $ref: '#/components/schemas/VmssPrincipalResult'
    MatchScreeningDetail:
      type: object
      required:
      - acquirerIdCode
      - legalName
      - address
      - doingBusinessAsName
      - principals
      - websiteUrl
      description: 'Post an array of principals with all details to be screened for the merchant.

        '
      properties:
        acquirerIdCode:
          $ref: '#/components/schemas/schemas-acquirerIdCode'
        legalName:
          allOf:
          - $ref: '#/components/schemas/ExtendedNameOfPeopleAndPlaces'
          - description: The legal name of the Merchant. Clients not enrolled in the "extended character set beta" are still subject to the `^[\w ,\.\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u00FF-\/]+$` pattern for field input. LegalName will be trimmed if it is longer then 60 chars.
        doingBusinessAsName:
          $ref: '#/components/schemas/schemas-doingBusinessAsName'
        address:
          $ref: '#/components/schemas/schemas-Address'
        websiteUrl:
          $ref: '#/components/schemas/schemas-url'
        principals:
          type: array
          description: The principals of the business
          minItems: 1
          maxItems: 5
          items:
            $ref: '#/components/schemas/MatchPrincipal'
    moreItems:
      type: boolean
    MatchProEmail:
      type: string
      description: Email address of a principal
      maxLength: 100
      pattern: \w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*
    bid:
      type: string
      description: Visa assigned Business Identifier (B

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