Silverflow

Silverflow Screenings API

GitHub OpenAPI

Operations 4

POST /screenings Create Screening Request [EXPERIMENTAL] #
GET /screenings List Screenings [EXPERIMENTAL] #
GET /screenings/{screeningsKey} Get a Screening [EXPERIMENTAL] #
GET /screenings/{screeningsKey}/results List Screening Results [EXPERIMENTAL] #

Documentation

📖
Documentation
https://docs.silverflow.com/
📖
APIReference
https://docs.silverflow.com/apidocs/latest/index.html
📖
GettingStarted
https://docs.silverflow.com/guides/getting-started
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/authentication/silverflow-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/rate-limits/silverflow-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/openapi/silverflow-screenings-api-openapi.yml

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/asyncapi/silverflow-events-webhooks.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/errors/silverflow-problem-types.yml
🔗
DeclineCodes
https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/errors/silverflow-decline-codes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/conventions/silverflow-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/conventions/silverflow-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/data-model/silverflow-data-model.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/sandbox/silverflow-sandbox.yml
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/mcp/silverflow-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/silverflow-screenings-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

silverflow-screenings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: '**This OpenAPI specification cannot be used for code generation.** Please reach out to your TAM regarding code generation using the API Spec.'
  version: 1.417.0
  title: Silverflow Screenings API
  contact:
    name: API Support
    email: support@silverflow.com
  license:
    name: Commercial
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.


        **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'
  /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'
  /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'
components:
  schemas:
    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'
    VmssScreeningRequest:
      type: object
      required:
      - screeningType
      - merchantKey
      - binKey
      - doingBusinessAsName
      - principals
      - businessPhoneNumbers
      - tradeOverInternet
      - businessCategory
      description: 'Post an array of principals with all details to be screened for the merchant acceptor.

        '
      properties:
        screeningType:
          type: string
          enum:
          - VMSS
        merchantKey:
          $ref: '#/components/schemas/merchantKey'
        binKey:
          $ref: '#/components/schemas/schemas-binKey'
        doingBusinessAsName:
          $ref: '#/components/schemas/vmssDoingBusinessAsName'
        businessPhoneNumbers:
          type: array
          description: Additional phone numbers of the merchant including the area code.
          minItems: 1
          maxItems: 5
          items:
            $ref: '#/components/schemas/businessPhoneNumber'
        tradeOverInternet:
          $ref: '#/components/schemas/tradeOverInternet'
        businessCategory:
          $ref: '#/components/schemas/businessCategory'
          description: Category of the business
        principals:
          type: array
          description: 'The principals of the business.


            Note: Duplicate principals with the same firstName and lastName (case-insensitive) will be automatically deduplicated, keeping only the first occurrence.

            '
          minItems: 1
          maxItems: 5
          items:
            $ref: '#/components/schemas/VmssPrincipal'
        bid:
          $ref: '#/components/schemas/bid'
    MatchProScreeningResult:
      type: object
      required:
      - acquirerIdCode
      - legalName
      - address
      - principals
      - doingBusinessAsName
      - websiteUrl
      properties:
        acquirerIdCode:
          $ref: '#/components/schemas/terminatedByAcquirerIdCode'
        legalName:
          $ref: '#/components/schemas/RecordMatchString'
        doingBusinessAsName:
          $ref: '#/components/schemas/RecordMatchString'
        merchantCategoryCode:
          $ref: '#/components/schemas/RecordMatchString'
        merchantPhoneNumber:
          $ref: '#/components/schemas/RecordMatchString'
        address:
          $ref: '#/components/schemas/AddressMatch'
        websiteUrl:
          $ref: '#/components/schemas/RecordMatchStringArray'
        principals:
          type: array
          items:
            $ref: '#/components/schemas/MatchProPrincipalResult'
    MatchProPrincipalInput:
      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:
          description: First name of the principal legal owner of the merchant
          $ref: '#/components/schemas/MatchPrincipalName'
        lastName:
          description: Last name of the principal legal owner of the merchant
          $ref: '#/components/schemas/MatchPrincipalName'
        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/MatchProAddressInput'
        email:
          $ref: '#/components/schemas/MatchProEmail'
    terminatedByAcquirerIdCode:
      type: string
      description: AcquirerIdCode that terminated the merchant.
    ScreeningDetail:
      oneOf:
      - $ref: '#/components/schemas/MatchScreeningDetail'
      - $ref: '#/components/schemas/MatchProScreeningDetail'
      - $ref: '#/components/schemas/VmssScreeningDetail'
    schemas-ProblemDetail:
      type: object
      description: 'The ''problem detail'' object relays detailed information about the error that occurred. It is defined

        by [RFC 7807 - Problem Details for HTTP APIs](https://tools.ietf.org/html/rfc7807).


        Note that additional properties may be used to relay error specific information. For instance,

        A Bad Request error may hold information about the individual validation errors found in the request.

        '
      properties:
        type:
          type: string
          description: 'An absolute URI that identifies the problem type.

            '
          default: about:blank
          example: https://api.silverflow.co/problem/constraint-violation
        title:
          type: string
          description: 'A short, summary of the problem type. Written in english and readable

            for engineers (usually not suited for non technical stakeholders and

            not localized);

            '
          example: Service Unavailable
        status:
          type: integer
          format: int32
          description: 'The HTTP status code generated by the origin server for this occurrence

            of the problem.

            '
          minimum: 100
          maximum: 599
          example: 503
        detail:
          type: string
          description: 'A human readable explanation specific to this occurrence of the

            problem.

            '
          example: Connection to database timed out
        instance:
          type: string
          description: 'An absolute URI that identifies the specific occurrence of the problem.

            It may or may not yield further information if dereferenced.

            '
      additionalProperties: true
      example:
        type: https://api.silverflow.co/problem/bad-request
        title: Bad Request
        status: 400
        detail: The request could not be processed as it contained an invalid request entity
        instance: https://api.silverflow.co/v1/merchants/mct-1hPdFqhgstYTUhlphPDp
        validationErrors:
        - The value of property 'status' should be one of 'idle', 'active' or 'archived'
        - The value of property 'tags.0.businessId' must not be longer than 255 characters
    VmssScreeningDetail:
      type: object
      required:
      - bid
      - doingBusinessAsName
      - address
      - principals
      - businessPhoneNumbers
      - tradeOverInternet
      - websiteUrl
      - businessCategory
      description: 'Post an array of principals with all details to be screened for the merchant acceptor.

        '
      properties:
        bid:
          $ref: '#/components/schemas/bid'
        doingBusinessAsName:
          $ref: '#/components/schemas/vmssDoingBusinessAsName'
        address:
          $ref: '#/components/schemas/schemas-Address'
        businessPhoneNumbers:
          type: array
          description: Additional phone numbers of the merchant including the area code.
          minItems: 1
          maxItems: 5
          items:
            $ref: '#/components/schemas/businessPhoneNumber'
        websiteUrl:
          $ref: '#/components/schemas/schemas-url'
        tradeOverInternet:
          $ref: '#/components/schemas/tradeOverInternet'
        businessCategory:
          $ref: '#/components/schemas/businessCategory'
          description: Category of the business
        principals:
          type: array
          description: The principals of the business
          minItems: 1
          maxItems: 5
          items:
            $ref: '#/components/schemas/VmssPrincipal'
    ErrorMessage:
      description: Error message in case `screeningStatus` is 'failed'.
      type: string
    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'
    created:
      type: string
      description: The date and time this object was created
      format: date-time
    countryCodeNumeric:
      type: string
      pattern: ^[0-9]+$
      minLength: 3
      maxLength: 3
      description: 'The ISO code of the country.


        **European ISO Country Codes**


        <details>


        | Country | Alpha-2 code | Numeric |

        | ------- | ------------ | ------- |

        | Åland Islands | AX | 248 |

        | Andorra | AD | 020 |

        | Austria | AT | 040 |

        | Belgium | BE | 056 |

        | Cyprus | CY | 196 |

        | Estonia | EE | 233 |  |

        | Finland | FI | 246 |

        | France | FR | 250 |

        | French Guiana | GF | 254 |

        | French Southern Territories | TF | 260 |

        | Germany | DE | 280 |

        | Greece | GR | 300 |

        | Guadeloupe | GP | 312 |

        | Ireland | IE | 372 |

        | Italy | IT | 380 |

        | Kosovo, United Nations Mission in Kosovo (UNMIK) | QZ | 900 |

        | Latvia | LV | 428 |

        | Lithuania | LT | 440 |

        | Luxembourg | LU | 442 |

        | Malta | MT | 470 |

        | Martinique | MQ | 474 |

        | Mayotte | YT | 175 |

        | Monaco | MC | 492 |

        | Montenegro | ME | 499 |

        | Netherlands | NL | 528 |

        | Portugal | PT | 620 |

        | Reunion | RE | 638 |

        | Saint Barthélemy | BL | 652 |

        | Saint Martin (French Part) | MF | 663 |

        | San Marino | SM | 674 |

        | Slovakia | SK | 703 |

        | Slovenia | SI | 705 |

        | Spain | ES | 724 |

        | St. Pierre and Miquelon | PM | 666 |

        | Vatican City State (Holy See) | VA | 336 |


        </details>


        **US ISO Country Codes**


        <details>


        | Country | Alpha-2 code | Numeric |

        | ------- | ------------ | ------- |

        | American Samoa | AS | 016 |

        | Bonaire, St. Eusasius and Saba | BQ | 535 |

        | British Indian Ocean Territory | IO | 086 |

        | Ecuador | EC | 218 |

        | Guam | GU | 316 |

        | Marshall Islands | MH | 584 |

        | Micronesia, Federated States of | FM | 583 |

        | Northern Mariana Islands | MP | 580 |

        | Palau | PW | 585 |

        | Palestine, State of | PS | 275 |

        | Puerto Rico | PR | 630 |

        | Timor-Leste | TP | 626 |

        | Turks and Caicos Islands | TC | 796 |

        | U.S. Minor Outlying Islands | UM | 581 |

        | United States | US | 840 |

        | Virgin Islands, British | VG | 092 |

        | Virgin Islands, U.S. | VI | 850 |


        </details>


        **Other ISO Country Codes**


        <details>


        | Country | Alpha-2 code | Numeric |

        | ------- | ------------ | ------- |

        | Afghanistan | AF | 004 |

        | Albania | AL | 008 |

        | Algeria | DZ | 012 |

        | Angola | AO | 024 |

        | Anguilla | AI | 660 |

        | Antarctica | AQ | 010 |

        | Antigua and Barbuda | AG | 028 |

        | Argentina | AR | 032 |

        | Armenia | AM | 051 |

        | Aruba | AW | 533 |

        | Australia | AU | 036 |

        | Azerbaijan | AZ | 031 |

        | Bahamas | BS | 044 |

        | Bahrain | BH | 048 |

        | Bangladesh | BD | 050 |

        | Barbados | BB | 052 |

        | Belarus | BR | 112 |

        | Belize | BZ | 084 |

        | Benin | BJ | 204 |

        | Bermuda | BM | 060 |

        | Bhutan | BT | 064 |

        | Bolivia, Plurinational State of | BO | 068 |

        | Bosnia and Herzegovina | BA | 070 |

        | Botswana | BW | 072 |

        | Bouvet Island | BV | 074 |

        | Brazil | BR | 076 |

        | Brunei Darussalam | BN | 096 |

        | Bulgaria | BG | 100 |

        | Burkina Faso | BF | 854 |

        | Burundi | BI | 108 |

        | Cambodia | KH | 116 |

        | Cameroon | CM | 120 |

        | Canada | CA | 124 |

        | Cape Verde | CV | 132 |

        | Cayman Islands | KY | 136 |

        | Central African Republic | CF | 140 |

        | Chad | TD | 148 |

        | Chile | CL | 152 |

        | China | CN | 156 |

        | Christmas Island | CX | 162 |

        | Cocos (Keeling) Islands | CC | 166 |

        | Colombia | CO | 170 |

        | Comoros | KM | 174 |

        | Congo | CG | 178 |

        | Cook Islands | CK | 184 |

        | Costa Rica | CR | 188 |

        | Côte D''Ivoire | CI | 384 |

        | Croatia | HR | 191 |

        | Cuba | CU | 192 |

        | Curacao | CW | 531 |

        | Czech Republic | CZ | 203 |

        | Democratic Republic of the Congo | CD | 180 |

        | Denmark | DK | 208 |

        | Djibouti | DJ | 262 |

        | Dominica | DM | 212 |

        | Dominican Republic | DO | 214 |

        | Egypt | EG | 818 |

        | El Salvador | SV | 222 |

        | Equatorial Guinea | GQ | 226 |

        | Eritrea | ER | 232 |

        | Ethiopia | ET | 230 |

        | Falkland Islands (Malvinas) | FK | 238 |

        | Faroe Islands | FO | 234 |

        | Fiji | FJ | 242 |

        | French Polynesia | PF | 258 |

        | Gabon | GA | 266 |

        | Gambia | GM | 270 |

        | Georgia | GE | 268 |

        | Ghana | GH | 288 |

        | Gibraltar | GI | 292 |

        | Greenland | GL | 304 |

        | Grenada | GD | 308 |

        | Guatemala | GT | 320 |

        | Guernsey | GG | 831 |

        | Guinea | GN | 324 |

        | Guinea-Bissau | GW | 624 |

        | Guyana | GY | 328 |

        | Haiti | HT | 332 |

        | Heard and McDonald Islands | HM | 334 |

        | Honduras | HN | 340 |

        | Hong Kong | HK | 344 |

        | Hungary | HU | 348 |

        | Iceland | IS | 352 |

        | India | IN | 356 |

        | Indonesia | ID | 360 |

        | Iraq | IQ | 368 |

        | Isle of Man | IM | 833 |

        | Israel | IL | 376 |

        | Jamaica | JM | 388 |

        | Japan | JP | 392 |

        | Jersey | JE | 832 |

        | Jordan | JO | 400 |

        | Kazakhstan | KZ | 398 |

        | Kenya | KE | 404 |

        | Kiribati | KI | 296 |

        | Korea, Republic of | KR | 410 |

        | Kuwait | KW | 414 |

        | Kyrgyzstan | KG | 417 |

        | Lao People''s Democratic Republic | LA | 418 |

        | Lebanon | LB | 422 |

        | Lesotho | LS | 426 |

        | Liberia | LR | 430 |

        | Libyan Arab Jamahiriya | LY | 434 |

        | Liechtenstein | LI | 438 |

        | Macao | MO | 446 |

        | Macedonia | MK | 807 |

        | Madagascar | MG | 450 |

        | Malawi | MW | 454 |

        | Malaysia | MY | 458 |

        | Maldives | MV | 462 |

        | Mali | ML | 466 |

        | Mauritania | MR | 478 |

        | Mauritius | MU | 480 |

        | Mexico | MX | 484 |

        | Moldova, Republic of | MD | 498 |

        | Mongolia | MN | 496 |

        | Montserrat | MS | 500 |

        | Morocco | MA | 504 |

        | Mozambique | MZ | 508 |

        | Myanmar (effective 1 November 2012) | MM | 104 |

        | Namibia | NA | 516 |

        | Nauru | NR | 520 |

        | Nepal | NP | 524 |

        | Netherlands Antilles | AN | 530 |

        | New Caledonia | NC | 540 |

        | New Zealand | NZ | 554 |

        | Nicaragua | NI | 558 |

        | Niger | NE | 562 |

        | Nigeria | NG | 566 |

        | Niue | NU | 570 |

        | Norfolk Island | NF | 574 |

        | Norway | NO | 578 |

        | Oman | OM | 512 |

        | Pakistan | PK | 586 |

        | Panama | PA | 591 |

        | Papua New Guinea | PG | 598 |

        | Paraguay | PY | 600 |

        | Peru | PE | 604 |

        | Philippines | PH | 608 |

        | Pitcairn | PN | 612 |

        | Poland | PL | 616 |

        | Qatar | QA | 634 |

        | Republic of South Sudan | SS | 728 |

        | Romania | RO | 642 |

        | Russian Federation | RU | 643 |

        | Rwanda | RW | 646 |

        | Samoa | WS | 882 |

        | Sao Tome and Principe | ST | 678 |

        | Saudi Arabia | SA | 682 |

        | Senegal | SN | 686 |

        | Serbia | RS | 688 |

        | Seychelles | SC | 690 |

        | Sierra Leone | SL | 694 |

        | Singapore | SG | 702 |

        | Sint Maarten (Dutch Part) | SX | 534 |

        | Solomon Islands | SB | 090 |

        | Somalia | SO | 706 |

        | South Africa | ZA | 710 |

        | South Georgia and the South Sandwich Islands | GS | 239 |

        | Sri Lanka | LK | 144 |

        | Saint Helena, Ascension and Tristan Da Cunha | SH | 654 |

        | St. Kitts and Nevis | KN | 659 |

        | St. Lucia | LC | 662 |

        | St. Vincent and the Grenadines | VC | 670 |

        | Suriname | SR | 740 |

        | Svalbard and Jan Mayen | SJ | 744 |

        | Swaziland | SZ | 748 |

        | Sweden | SE | 752 |

        | Switzerland | CH | 756 |

        | Taiwan | TW | 158 |

        | Tajikistan | TJ | 762 |

        | Tanzania, United Republic of | TZ | 834 |

        | Thailand | TH | 764 |

        | Togo | TG | 768 |

        | Tokelau | TK | 772 |

        | Tonga | TO | 776 |

        | Trinidad and Tobago | TT | 780 |

        | Tunisia | TN | 788 |

        | Turkey | TR | 792 |

        | Turkmenistan | TM | 795 |

        | Tuvalu | TV | 798 |

        | Uganda | UG | 800 |

        | Ukraine | UA | 804 |

        | United Arab Emirates | AE | 784 |

        | United Kingdom | GB | 826 |

        | Uruguay | UY | 858 |

        | Uzbekistan | UZ | 860 |

        | Vanuatu | VU | 548 |

        | Venezuela, Bolivarian Republic of | VE | 862 |

        | Vietnam | VN | 704 |

        | Wallis and Futuna | WF | 876 |

        | Western Sahara | EH | 732 |

        | Yemen | YE | 886 |

        | Zambia | ZM | 894 |

        | Zimbabwe | ZW | 716 |


        </details>'
      externalDocs:
        description: Find more info here
        url: https://www.iso.org/iso-3166-country-codes.html
      example: '528'
    status:
      type: string
      description: The status of the object
      enum:
      - active
      - archived
    visaPrincipalLastName:
      type: string
      pattern: ^[\w ,\.\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u00FF-]+$
      minLength: 1
      maxLength: 15
    offsetToken:
      type: string
      pattern: ^[a-zA-Z0-9%]+$
      minLength: 1
      maxLength: 2048
    screeningType:
      type: string
      enum:
      - MATCH
      - VMSS
      - MATCH_PRO
    agentKey:
      description: Uniquely identifies an Agent
      type: string
      pattern: ^cgt-[a-zA-Z0-9]+|current$
      example: cgt-1UF2NafdfrdPMf2XrS2
    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
    tradeOverInternet:
      type: boolean
      description: TradeOverInternet
    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'
    CountryCodeNumeric:
      type: object
      required:
      - numeric
      additionalProperties: false
      properties:
        numeric:
          $ref: '#/components/schemas/countryCodeNumeric'
    schemas-postalCode:
      type: string
      pattern: ^[A-Z0-9]+([ -][A-Z0-9]+)?$
      minLength: 1
      maxLength: 10
      description: 'The postal code of the address. Clients not enrolled in the "extended character set beta" are still subject to the `^[A-Z0-9]+(\ [A-Z0-9]*)?$` pattern for field input.

        '
      example:
      - 1114 AA
      - 1115SB
      - EC1A 1BB
      - 123-456
      - M1 1AE
    schemas-url:
      type: string
      description: A valid URL
      pattern: ^http(s)?:\/\/[a-z0-9-_]+(\.[a-z0-9-_]+)+(/.*)?$
      minLength: 8
      maxLength: 2048
    visaPrincipalName:
      type: string
      pattern: ^[\w ,\.\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u00FF-]+$
      minLength: 1
      maxLength: 15
    VmssPrincipal:
      type: object
      required:
      - firstName
      - lastName
      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/visaPrincipalName'
        lastName:
          allOf:
          - description: Last name of the principal legal owner of the merchant
          - $ref: '#/components/schemas/visaPrincipalLastName'
    InvalidInputErrorDetails:
      type: object
      required:
      - type
      - title
      - status
      - detail
      - instance
      properties:
        type:
          type: string
          description: A relative URI reference, this property can be used to perform automated error handling.
          enum:
          - /silverflow/problems/invalid-input
        title:
          type: string
          description: A short, human-readable summary of the problem type. It does not change from occurrence to occurrence of the error.
          enum:
          - Invalid Input
        status:
          type: integer
          format: int32
          description: The HTTP status code generated by the origin server for this occurrence of the problem.
          enum:
          - 400
        detail:
          type: string
          description: A human readable explanation specific to this occurrence of the problem.
        instance:
          type: string
          description: A reference that identifies the specific occurrence of the error. The instance is unique for every error.
        validationErrors:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
          description: A list of validation errors.
    MatchScreeningResult:
      type: object
      required:
      - acquirerIdCode
      - legalName
      - address
      - principals
      - doingBusinessAsName
      - websiteUrl
      properties:
        acquirerIdCode:
          $ref: '#/components/schemas/terminatedByAcquirerIdCode'
        legalName:
          $ref: '#/components/schemas/RecordMatchString'
        doingBusinessAsName:
          $ref: '#/components/schemas/RecordMatchString'
        address:
          $ref: '#/components/schemas/AddressMatch'
        websiteUrl:
          $ref: '#/components/schemas/RecordMatchStringArray'
        principals:
          type: array
          items:
            $ref: '#/components/schemas/MatchPrincipalResult'
    screeningResult:
      type: object
      required:
      - terminatedMerchant
      - terminationReason
      properties:
        terminationReason:
          $ref: '#/components/schemas/terminationReason'
        terminatedMerchant:
          $ref: '#/components/schemas/terminatedMerchant'
    lastModified:
      type: string
      description: The date and time this object was last modified
      format: date-time
    moreItems:
      type: boolean
    CountryCodeAlpha2:
      type: object
      required:
      - alpha2
      additionalProperties: false
      properties:
        alpha2:
          $ref: '#/components/schemas/countryCodeAlpha2'
    matchType:
      type: string
      enum:
      - none
      - partial
      - phonetic


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