How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Silverflow Screenings API is one of 50 APIs that Silverflow publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Screenings. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 4 operations across 3 paths, and defines 75 schemas. It is described by OpenAPI 3.2.0, at version 1.417.0.

Requests are made against 3 base URLs: https://eu-west-1.api.silverflow.com/v1, https://us-east-2.api.silverflow.com/v1, https://eu-west-1.api-sbx.silverflow.com/v1.

4 operations 3 paths 75 schemas 3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.417.0
Base URL
https://eu-west-1.api.silverflow.com/v1
Authentication
HTTP Basic, HTTP Bearer, API Key
License
Commercial
Resource Areas
1

Authentication & Security 3

Silverflow Screenings API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (ApiKey). It accepts HTTP bearer tokens (JWT) (BearerToken). An API key is passed in the header as - (MutualTLS). By default, every request must be authenticated.

  • ApiKey — The primary method of authenticating to the Silverflow API is through API keys. API keys can be created by calling the [createApiKey](operation/createApiKey) e…
  • BearerToken — Bearer tokens are temporary security credentials that can be used to authorize 'third parties' (bearers) access to the Silverflow API on behalf of the agent. T…
  • MutualTLS — The client must set up mTLS connection with a valid X.509 client certificate signed by a customer-provided CA (certificate authority) that is registered to a s…

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Screenings 4
POST
/screenings
Create Screening Request [EXPERIMENTAL]
postScreening body → 201400401403404429
GET
/screenings
List Screenings [EXPERIMENTAL]
listScreenings 5 params → 200400401403404429
GET
/screenings/{screeningsKey}
Get a Screening [EXPERIMENTAL]
getScreening 1 param → 200400401403404429
GET
/screenings/{screeningsKey}/results
List Screening Results [EXPERIMENTAL]
listScreeningResults 4 params → 200400401403404409429

Schemas 75

The contract defines 75 schemas that model the data the API accepts and returns. The most detailed are Screening (13 properties), VmssScreeningRequest (9 properties), VmssScreeningDetail (8 properties), MatchProScreeningDetail (8 properties). Each schema is shown below with its type and property counts.

schemas-line2
MatchProScreeningRequest
object
Post an array of principals with all details to be screened for the merchant acceptor.
7 properties 7 required
ScreeningDetail
tradeOverInternet
boolean
TradeOverInternet
ScreeningRequest
version
integer
The version of this object
CountryCodeAlpha2
object
1 property 1 required
visaPrincipalLastName
string
status
string
The status of the object
businessPhoneNumber
string
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. Wit…
schemas-acquirerIdCode
string
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 sa…
ValidationError
object
3 properties 2 required
ExtendedNameOfPeopleAndPlaces
string
ScreeningsPage
RecordMatchStringArray
object
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.
2 properties 2 required
terminatedMerchant
CountryCode
object
3 properties 3 required
RecordMatchString
object
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
2 properties 1 required
schemas-city
MatchProPrincipal
object
A principal of the business. Could be a director, founder, C-level executive, et cetera.
5 properties 5 required
screeningKey
string
Uniquely identifies a screening
vmssDoingBusinessAsName
string
Assumed, trade or fictitious name of the merchant. The name will be trimmed if greater than 70.
VmssScreeningResult
object
6 properties 6 required
MatchScreeningDetail
object
Post an array of principals with all details to be screened for the merchant.
6 properties 6 required
moreItems
boolean
MatchProEmail
string
Email address of a principal
bid
string
Visa assigned Business Identifier (BID) of the Acquirer.
screeningResult
object
2 properties 2 required
countryCodeNumeric
string
The ISO code of the country. European ISO Country Codes | Country | Alpha-2 code | Numeric | | ------- | ------------ | ------- | | Åland Islands | AX | 248 |…
terminationReason
string
VmssScreeningRequest
object
Post an array of principals with all details to be screened for the merchant acceptor.
9 properties 8 required
totalNumberOfResults
number
Indicates the number of merchants that matched with the search criteria. totalNumberOfResults will be available when screening is completed.
CountryCodeNumeric
object
1 property 1 required
InvalidInputErrorDetails
object
6 properties 5 required
Screening
object
A response on a submitted screening request.
13 properties 10 required
MatchProPrincipalInput
object
A principal of the business. Could be a director, founder, C-level executive, et cetera.
5 properties 5 required
VmssPrincipal
object
A principal of the business. Could be a director, founder, C-level executive, et cetera.
2 properties 2 required
businessCategory
string
offsetToken
string
AddressMatch
object
5 properties
created
string
The date and time this object was created
schemas-url
string
A valid URL
screeningType
string
ErrorMessage
string
Error message in case screeningStatus is 'failed'.
visaPrincipalName
string
NameOfPeopleAndPlaces
string
MatchProPrincipalResult
object
5 properties 4 required
schemas-binKey
string
A key assigned by Silverflow to uniquely identify a BIN.
schemas-stateOrProvince
schemas-Address
object
A physical postal address
6 properties 4 required
MatchPrincipalName
string
MatchPrincipalResult
object
4 properties 4 required
MatchProScreeningDetail
object
Post an array of principals with all details to be screened for the merchant.
8 properties 8 required
MatchProAddressInput
object
A physical postal address
6 properties 4 required
terminatedByAcquirerIdCode
string
AcquirerIdCode that terminated the merchant.
MatchProScreeningResult
object
8 properties 6 required
merchantKey
string
Uniquely identifies a Merchant
MatchScreeningResult
object
6 properties 6 required
Page
object
2 properties
MatchPrincipal
object
A principal of the business. Could be a director, founder, C-level executive, et cetera.
4 properties 4 required
countryCodeAlpha2
string
The ISO code of the country. European ISO Country Codes | Country | Alpha-2 code | Numeric | | ------- | ------------ | ------- | | Åland Islands | AX | 248 |…
schemas-doingBusinessAsName
countryCodeAlpha3
string
The ISO code of the country. European ISO Country Codes | Country | Alpha-2 code | Numeric | | ------- | ------------ | ------- | | Åland Islands | AX | 248 |…
schemas-line1
schemas-ProblemDetail
object
The 'problem detail' object relays detailed information about the error that occurred. It is defined by [RFC 7807 - Problem Details for HTTP APIs](https://tool…
5 properties
ScreeningResultsPage
CountryCodeInput
lastModified
string
The date and time this object was last modified
screeningStatus
string
Status of the screening request
VmssPrincipalResult
object
2 properties 2 required
schemas-postalCode
string
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 i…
VmssScreeningDetail
object
Post an array of principals with all details to be screened for the merchant acceptor.
8 properties 8 required
matchType
string
CountryCodeAlpha3
object
1 property 1 required
agentKey
string
Uniquely identifies an Agent

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

silverflow-screenings-api-openapi.yml Raw ↑

Other APIs Silverflow publishes across the network.

Silverflow 3DS Authentication API
Silverflow Agents API
Silverflow AMMF Submission Events API
Silverflow API Keys API
Silverflow BEP Authentication API
Silverflow Bins API
Silverflow Card Info API
Silverflow Card Management API
Silverflow Card Network Reports API
Silverflow Charge Actions API
Silverflow Charges Events API
Silverflow Charges Reports API
Where this information came from

This is an independent, third-party profile of Silverflow Screenings API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.