- Previous: Amendment
- Up: Merchant Digital Onboarding
- Next: Notification Service
Screening
# Request structure
- requestId: mandatory unique identifier for tracking the screening request
- merchant: mandatory business entity
- shareholders: optional list of business shareholders
- identifier: mandatory unique identifier for merchant (Trade license or GIIN) and primary ID document for shareholders
- id: mandatory merchant id
- name: mandatory merchant name
- website: optional merchant website URL or ecommerce merchants
- establishmentDate/birthday: mandatory for Fiserv screening (yyyy-MM-dd)
- address: mandatory for Match screening
- address.stateCode: mandatory when countryCode is USA or CAN, it accepts two letters that represent state
- address.countryCode: mandatory 3 letter country code (ISO 3166)
- establishmentCountry: optional 3 letter country code of business entity
- nationality: optional for Fiserv shareholder screening (3 letter country code)
- phoneNumber: mandatory for Match screening (max 10-12 digits including country code)
```json
{
"requestId": "{{requestId}}",
"payload": {
"merchant": {
"identifier": "tradeLicenseNumber",
"id": "4856849485",
"name": "Pet Shot LCC",
"website": "https://www.petshottest.com",
"phoneNumber": "971551234567",
"establishmentDate": "2020-01-20",
"establishmentCountry" : "ARE",
"address": {
"countryCode": "ARE",
"city": "Dubai",
"postalCode": "12345",
"addressLines": [
"Line1",
"Line2"
]
},
"shareholders": [
{
"identifier": "passportNumber",
"firstName": "Fname",
"lastName": "Lname",
"phoneNumber": "971551212123",
"nationality": "ARE",
"birthDate": "1983-10-16",
"address": {
"countryCode": "USA",
"stateCode": "TN",
"city": "Dallas",
"postalCode": "12340",
"addressLines": [
"LineA",
"LineB"
]
}
}
]
}
}
}
```
## Fields scope
| Field | Scope |
| ------ | ------ |
| merchant.identifier | FISERV, MATCH |
| merchant.id | TRUSTWAVE |
| merchant.name | FISERV, MATCH |
| merchant.website | TRUSTWAVE |
| merchant.phoneNumber | MATCH |
| merchant.establishmentDate | FISERV |
| merchant.establishmentCountry | FISERV |
| merchant.address| MATCH |
| shareholder.shareholderId| FISERV, MATCH |
| shareholder.firstName| FISERV, MATCH |
| shareholder.lastName| FISERV, MATCH |
| shareholder.phoneNumer| MATCH |
| shareholder.nationality| FISERV |
| shareholder.birthDate| FISERV |
| shareholder.address| MATCH |
# Response structure
- entityId: merchant/shareholder provided identifier
- screeningResult:
- result: results of screenings systems (FISERV, MATCH) possible values are (GO, STOP, ON_HOLD, ERROR)
- matchedMerchants: String of JSON content. It contains a list of possible terminated merchants info , this field only exist in case of MATCH and when the status is STOP or ON_HOLD.
```json
{
"entities": [
{
"entityId": "111222333",
"screeningResult": {
"MATCH": {
"entityId": "111222333",
"result": "ON_HOLD",
"matchedMerchants": "[{\"name\":\"THE BAIT SHOP\",\"doingBusinessAsName\":\"BAIT R US\",\"phoneNumber\":\"6367558963\",\"altPhoneNumber\":\"6367558968\",\"nationalTaxId\":\"*****\",\"countrySubdivisionTaxId\":\"*****\",\"serviceProvLegal\":\"XYZ FINANCIAL SERVICE INCORPORATED\",\"serviceProvDBA\":\"XYZ FINANCIAL SERVICE\",\"addedOnDate\":\"07/07/2020\",\"terminationReasonCode\":\"13\",\"terminationReasonDescription\":\"Illegal Transactions\",\"addedByAcquirerID\":\"1996\",\"address\":{\"line1\":\"42 ELM AVENUE\",\"line2\":\"SUITE 201\",\"city\":\"DALLAS\",\"countrySubdivision\":null,\"province\":null,\"postalCode\":\"66579\",\"country\":\"GBR\"},\"principal\":[{\"firstName\":\"DAVID\",\"middleInitial\":null,\"lastName\":\"SMITH\",\"phoneNumber\":\"3165557625\",\"altPhoneNumber\":\"3165557625\",\"nationalId\":\"*****\",\"address\":{\"line1\":\"42 ELM AVENUE\",\"line2\":\"SUITE 201\",\"city\":\"DALLAS\",\"countrySubdivision\":\"IL\",\"province\":null,\"postalCode\":\"66579\",\"country\":\"USA\"},\"driversLicense\":{\"number\":\"*****\",\"countrySubdivision\":\"IL\",\"country\":\"USA\"}}]},{\"name\":\"THE BAIT SHOP\",\"doingBusinessAsName\":\"BAIT R US\",\"phoneNumber\":\"6367558963\",\"altPhoneNumber\":\"6367558968\",\"nationalTaxId\":\"*****\",\"countrySubdivisionTaxId\":\"*****\",\"serviceProvLegal\":\"XYZ FINANCIAL SERVICE INCORPORATED\",\"serviceProvDBA\":\"XYZ FINANCIAL SERVICE\",\"addedOnDate\":\"02/10/2017\",\"terminationReasonCode\":\"13\",\"terminationReasonDescription\":\"Illegal Transactions\",\"addedByAcquirerID\":\"1996\",\"address\":{\"line1\":\"42 ELM AVENUE\",\"line2\":\"SUITE 201\",\"city\":\"DALLAS\",\"countrySubdivision\":\"IL\",\"province\":null,\"postalCode\":\"66579\",\"country\":\"USA\"},\"principal\":[{\"firstName\":\"DAVID\",\"middleInitial\":null,\"lastName\":\"SMITH\",\"phoneNumber\":\"3165557625\",\"altPhoneNumber\":\"3165557625\",\"nationalId\":\"*****\",\"address\":{\"line1\":\"42 ELM AVENUE\",\"line2\":\"SUITE 201\",\"city\":\"DALLAS\",\"countrySubdivision\":\"IL\",\"province\":null,\"postalCode\":\"66579\",\"country\":\"USA\"},\"driversLicense\":{\"number\":\"*****\",\"countrySubdivision\":\"IL\",\"country\":\"USA\"}}]},{\"name\":\"THE BAIT SHOP\",\"doingBusinessAsName\":\"BAIT R US\",\"phoneNumber\":\"6367558963\",\"altPhoneNumber\":\"6367558968\",\"nationalTaxId\":\"*****\",\"countrySubdivisionTaxId\":\"*****\",\"serviceProvLegal\":\"XYZ FINANCIAL SERVICE INCORPORATED\",\"serviceProvDBA\":\"XYZ FINANCIAL SERVICE\",\"addedOnDate\":\"03/22/2017\",\"terminationReasonCode\":\"13\",\"terminationReasonDescription\":\"Illegal Transactions\",\"addedByAcquirerID\":\"1996\",\"address\":{\"line1\":\"42 ELM AVENUE\",\"line2\":\"SUITE 201\",\"city\":\"DALLAS\",\"countrySubdivision\":\"IL\",\"province\":null,\"postalCode\":\"66579\",\"country\":\"USA\"},\"principal\":[{\"firstName\":\"DAVID\",\"middleInitial\":null,\"lastName\":\"SMITH\",\"phoneNumber\":\"3165557625\",\"altPhoneNumber\":\"3165557625\",\"nationalId\":\"*****\",\"address\":{\"line1\":\"42 ELM AVENUE\",\"line2\":\"SUITE 201\",\"city\":\"DALLAS\",\"countrySubdivision\":\"IL\",\"province\":null,\"postalCode\":\"66579\",\"country\":\"USA\"},\"driversLicense\":{\"number\":\"*****\",\"countrySubdivision\":\"IL\",\"country\":\"USA\"}}]},{\"name\":\"THE BAIT SHOP\",\"doingBusinessAsName\":\"BAIT R US\",\"phoneNumber\":\"6367558963\",\"altPhoneNumber\":\"6367558968\",\"nationalTaxId\":\"*****\",\"countrySubdivisionTaxId\":\"*****\",\"serviceProvLegal\":\"XYZ FINANCIAL SERVICE INCORPORATED\",\"serviceProvDBA\":\"XYZ FINANCIAL SERVICE\",\"addedOnDate\":\"04/04/2017\",\"terminationReasonCode\":\"13\",\"terminationReasonDescription\":\"Illegal Transactions\",\"addedByAcquirerID\":\"1996\",\"address\":{\"line1\":\"42 ELM AVENUE\",\"line2\":\"SUITE 201\",\"city\":\"DALLAS\",\"countrySubdivision\":\"IL\",\"province\":null,\"postalCode\":\"66579\",\"country\":\"USA\"},\"principal\":[{\"firstName\":\"DAVID\",\"middleInitial\":null,\"lastName\":\"SMITH\",\"phoneNumber\":\"3165557625\",\"altPhoneNumber\":\"3165557625\",\"nationalId\":\"*****\",\"address\":{\"line1\":\"42 ELM AVENUE\",\"line2\":\"SUITE 201\",\"city\":\"DALLAS\",\"countrySubdivision\":\"IL\",\"province\":null,\"postalCode\":\"66579\",\"country\":\"USA\"},\"driversLicense\":{\"number\":\"*****\",\"countrySubdivision\":\"IL\",\"country\":\"USA\"}}]},{\"name\":\"THE BAIT SHOP\",\"doingBusinessAsName\":\"BAIT R US\",\"phoneNumber\":\"6367558963\",\"altPhoneNumber\":\"6367558968\",\"nationalTaxId\":\"*****\",\"countrySubdivisionTaxId\":\"*****\",\"serviceProvLegal\":\"XYZ FINANCIAL SERVICE INCORPORATED\",\"serviceProvDBA\":\"XYZ FINANCIAL SERVICE\",\"addedOnDate\":\"04/26/2017\",\"terminationReasonCode\":\"13\",\"terminationReasonDescription\":\"Illegal Transactions\",\"addedByAcquirerID\":\"1996\",\"address\":{\"line1\":\"42 ELM AVENUE\",\"line2\":\"SUITE 201\",\"city\":\"DALLAS\",\"countrySubdivision\":\"IL\",\"province\":null,\"postalCode\":\"66579\",\"country\":\"USA\"},\"principal\":[{\"firstName\":\"DAVID\",\"middleInitial\":null,\"lastName\":\"SMITH\",\"phoneNumber\":\"3165557625\",\"altPhoneNumber\":\"3165557625\",\"nationalId\":\"*****\",\"address\":{\"line1\":\"42 ELM AVENUE\",\"line2\":\"SUITE 201\",\"city\":\"DALLAS\",\"countrySubdivision\":\"IL\",\"province\":null,\"postalCode\":\"66579\",\"country\":\"USA\"},\"driversLicense\":{\"number\":\"*****\",\"countrySubdivision\":\"IL\",\"country\":\"USA\"}}]},{\"name\":\"THE BAIT SHOP\",\"doingBusinessAsName\":\"BAIT R US\",\"phoneNumber\":\"6367558963\",\"altPhoneNumber\":\"6367558968\",\"nationalTaxId\":\"*****\",\"countrySubdivisionTaxId\":\"*****\",\"serviceProvLegal\":\"XYZ FINANCIAL SERVICE INCORPORATED\",\"serviceProvDBA\":\"XYZ FINANCIAL SERVICE\",\"addedOnDate\":\"08/09/2017\",\"terminationReasonCode\":\"13\",\"terminationReasonDescription\":\"Illegal Transactions\",\"addedByAcquirerID\":\"1996\",\"address\":{\"line1\":\"42 ELM AVENUE\",\"line2\":\"SUITE 201\",\"city\":\"DALLAS\",\"countrySubdivision\":\"IL\",\"province\":null,\"postalCode\":\"66579\",\"country\":\"USA\"},\"principal\":[{\"firstName\":\"DAVID\",\"middleInitial\":null,\"lastName\":\"SMITH\",\"phoneNumber\":\"3165557625\",\"altPhoneNumber\":\"3165557625\",\"nationalId\":\"*****\",\"address\":{\"line1\":\"42 ELM AVENUE\",\"line2\":\"SUITE 201\",\"city\":\"DALLAS\",\"countrySubdivision\":\"IL\",\"province\":null,\"postalCode\":\"66579\",\"country\":\"USA\"},\"driversLicense\":{\"number\":\"*****\",\"countrySubdivision\":\"IL\",\"country\":\"USA\"}}]},{\"name\":\"THE BAIT SHOP\",\"doingBusinessAsName\":\"BAIT R US\",\"phoneNumber\":\"6367558963\",\"altPhoneNumber\":\"6367558968\",\"nationalTaxId\":\"*****\",\"countrySubdivisionTaxId\":\"*****\",\"serviceProvLegal\":\"XYZ FINANCIAL SERVICE INCORPORATED\",\"serviceProvDBA\":\"XYZ FINANCIAL SERVICE\",\"addedOnDate\":\"08/14/2017\",\"terminationReasonCode\":\"13\",\"terminationReasonDescription\":\"Illegal Transactions\",\"addedByAcquirerID\":\"1996\",\"address\":{\"line1\":\"42 ELM AVENUE\",\"line2\":\"SUITE 201\",\"city\":\"DALLAS\",\"countrySubdivision\":\"IL\",\"province\":null,\"postalCode\":\"66579\",\"country\":\"USA\"},\"principal\":[{\"firstName\":\"DAVID\",\"middleInitial\":null,\"lastName\":\"SMITH\",\"phoneNumber\":\"3165557625\",\"altPhoneNumber\":\"3165557625\",\"nationalId\":\"*****\",\"address\":{\"line1\":\"42 ELM AVENUE\",\"line2\":\"SUITE 201\",\"city\":\"DALLAS\",\"countrySubdivision\":\"IL\",\"province\":null,\"postalCode\":\"66579\",\"country\":\"USA\"},\"driversLicense\":{\"number\":\"*****\",\"countrySubdivision\":\"IL\",\"country\":\"USA\"}}]},{\"name\":\"THE BAIT SHOP\",\"doingBusinessAsName\":\"BAIT R US\",\"phoneNumber\":\"6367558963\",\"altPhoneNumber\":\"6367558968\",\"nationalTaxId\":\"*****\",\"countrySubdivisionTaxId\":\"*****\",\"serviceProvLegal\":\"XYZ FINANCIAL SERVICE INCORPORATED\",\"serviceProvDBA\":\"XYZ FINANCIAL SERVICE\",\"addedOnDate\":\"08/16/2017\",\"terminationReasonCode\":\"13\",\"terminationReasonDescription\":\"Illegal Transactions\",\"addedByAcquirerID\":\"1996\",\"address\":{\"line1\":\"42 ELM AVENUE\",\"line2\":\"SUITE 201\",\"city\":\"DALLAS\",\"countrySubdivision\":\"IL\",\"province\":null,\"postalCode\":\"66579\",\"country\":\"USA\"},\"principal\":[{\"firstName\":\"DAVID\",\"middleInitial\":null,\"lastName\":\"SMITH\",\"phoneNumber\":\"3165557625\",\"altPhoneNumber\":\"3165557625\",\"nationalId\":\"*****\",\"address\":{\"line1\":\"42 ELM AVENUE\",\"line2\":\"SUITE 201\",\"city\":\"DALLAS\",\"countrySubdivision\":\"IL\",\"province\":null,\"postalCode\":\"66579\",\"country\":\"USA\"},\"driversLicense\":{\"number\":\"*****\",\"countrySubdivision\":\"IL\",\"country\":\"USA\"}}]},{\"name\":\"THE BAIT SHOP\",\"doingBusinessAsName\":\"BAIT R US\",\"phoneNumber\":\"6367558963\",\"altPhoneNumber\":\"6367558968\",\"nationalTaxId\":\"*****\",\"countrySubdivisionTaxId\":\"*****\",\"serviceProvLegal\":\"XYZ FINANCIAL SERVICE INCORPORATED\",\"serviceProvDBA\":\"XYZ FINANCIAL SERVICE\",\"addedOnDate\":\"08/16/2017\",\"terminationReasonCode\":\"13\",\"terminationReasonDescription\":\"Illegal Transactions\",\"addedByAcquirerID\":\"1996\",\"address\":{\"line1\":\"42 ELM AVENUE\",\"line2\":\"SUITE 201\",\"city\":\"DALLAS\",\"countrySubdivision\":\"IL\",\"province\":null,\"postalCode\":\"66579\",\"country\":\"USA\"},\"principal\":[{\"firstName\":\"DAVID\",\"middleInitial\":null,\"lastName\":\"SMITH\",\"phoneNumber\":\"3165557625\",\"altPhoneNumber\":\"3165557625\",\"nationalId\":\"*****\",\"address\":{\"line1\":\"42 ELM AVENUE\",\"line2\":\"SUITE 201\",\"city\":\"DALLAS\",\"countrySubdivision\":\"IL\",\"province\":null,\"postalCode\":\"66579\",\"country\":\"USA\"},\"driversLicense\":{\"number\":\"*****\",\"countrySubdivision\":\"IL\",\"country\":\"USA\"}}]},{\"name\":\"THE BAIT SHOP\",\"doingBusinessAsName\":\"BAIT R US\",\"phoneNumber\":\"6367558963\",\"altPhoneNumber\":\"6367558968\",\"nationalTaxId\":\"*****\",\"countrySubdivisionTaxId\":\"*****\",\"serviceProvLegal\":\"XYZ FINANCIAL SERVICE INCORPORATED\",\"serviceProvDBA\":\"XYZ FINANCIAL SERVICE\",\"addedOnDate\":\"08/16/2017\",\"terminationReasonCode\":\"13\",\"terminationReasonDescription\":\"Illegal Transactions\",\"addedByAcquirerID\":\"1996\",\"address\":{\"line1\":\"42 ELM AVENUE\",\"line2\":\"SUITE 201\",\"city\":\"DALLAS\",\"countrySubdivision\":\"IL\",\"province\":null,\"postalCode\":\"66579\",\"country\":\"USA\"},\"principal\":[{\"firstName\":\"DAVID\",\"middleInitial\":null,\"lastName\":\"SMITH\",\"phoneNumber\":\"3165557625\",\"altPhoneNumber\":\"3165557625\",\"nationalId\":\"*****\",\"address\":{\"line1\":\"42 ELM AVENUE\",\"line2\":\"SUITE 201\",\"city\":\"DALLAS\",\"countrySubdivision\":\"IL\",\"province\":null,\"postalCode\":\"66579\",\"country\":\"USA\"},\"driversLicense\":{\"number\":\"*****\",\"countrySubdivision\":\"IL\",\"country\":\"AUS\"}}]}]"
},
"FISERV": {
"entityId": "111222333",
"result": "GO"
}
}
},
{
"entityId": "999222777",
"screeningResult": {
"FISERV": {
"entityId": "999222777",
"result": "GO"
}
}
}
]
}
```
- Previous: Amendment
- Up: Merchant Digital Onboarding
- Next: Notification Service
Docs Navigation
- API Security
- Falcon Services
- Card Services
- BETA
- Version 1.0
- Card Balance Enquiry
- Card Activation
- Card Set Pin
- Card Change PIN
- Card PIN Verification
- Card Status Update
- Card Limit Update
- Card Details
- Customer Details
- List Of Cards
- Customer Demographic Update
- Card Used Limits
- Card Statement Summary
- Card Transaction
- Utility Payments
- Account Create
- Account Update
- Account Closure
- Card Create
- Card Update
- Card Replacement
- Client Create
- Client Update
- Transaction Details
- PIN Retries Counter Reset
- Digital Status Chnage
- Get CVV2 Service
- Card Link Delink
- Card Insurance Products
- Card Change Insurance Product Status
- Card Direct Debit
- Update Card Direct Debit
- Card Balance Conversion Enquiry
- Card Balance Conversion
- Card Transaction Eligibility
- Card Transaction EPP Conversion
- Card Replacement Embossing
- Card NMON Transactions
- Retail Banking Transactions
- Appendix 1
- Appendix 2
- Appendix 3
- Appendix 4
- HTTP Codes
- Error Codes
- Version 2.0
- Lookup Card Identifier
- List Of Cards
- Card Activation
- Card Set PIN
- Card Change PIN
- Card Status Update
- Client Create
- Account Create
- Card Create
- Customer Demographic Update
- Account Update
- Card Update
- Card Replacement
- Customer Details
- Card Details
- Client Update
- Card Balance Enquiry
- Card Transaction
- Card Limit Update
- Card PIN Verification
- PIN Retried Counter Reset
- Get CVV2 Service
- Card Verification
- Card Transaction Details
- Get Encryption Certificate
- Get Dictionaries MCC
- Get Account Balance
- Card Insurance Product
- Card Insurance Product Update
- Card Direct Debit Update
- Card Direct Debit
- P2P Transfer
- Account Transaction
- Account Status Change
- Card Statement Summary
- Account Transaction Details
- Card Contact Details
- List of Accounts
- Account Hierarchy
- Notification Service
- Appendix 1
- Appendix 2
- Appendix 3
- Appendix 4
- HTTP Codes
- Error Codes
- Buy Now Pay Later
- Card Limits
- Insurance Services
- Webhook Services
- Switch Services
- Card Control Services
- Merchant Digital Onboarding
- Notification Service
- SMS Security Services
- Terms and Condition
0 Comments
Please sign in to post a comment.